IVsFileBackup.BackupFile(String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TextManager.Interop
Assembly:
Microsoft.VisualStudio.TextManager.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Persists the object to a single file

public:
 int BackupFile(System::String ^ pszBackupFileName);
public:
 int BackupFile(Platform::String ^ pszBackupFileName);
int BackupFile(std::wstring const & pszBackupFileName);
public int BackupFile (string pszBackupFileName);
abstract member BackupFile : string -> int
Public Function BackupFile (pszBackupFileName As String) As Integer

Parameters

pszBackupFileName
String

[in] Filename to persist.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsFileBackup::BackupFile(  
   [in] LPCOLESTR pszBackupFileName  
);

IVsFileBackup.BackupFile must not modify any internal state, but should clear the secondary dirty bit. BackupFile must return either STG_S_DATALOSS or STG_E_INVALIDCODEPAGE if there is no way to persist to a file without data loss.

Applies to