IVsFileBackup::BackupFile Method (String^)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Persists the object to a single file

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int BackupFile(
	String^ pszBackupFileName
)

Parameters

pszBackupFileName: Type: System::String^
[in] Filename to persist.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From textmgr.idl:

C++

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.