Partager via


IVsFileBackup.BackupFile Method

Persists the object to a single file

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

Syntax

'Declaration
Function BackupFile ( _
    pszBackupFileName As String _
) As Integer
int BackupFile(
    string pszBackupFileName
)
int BackupFile(
    [InAttribute] String^ pszBackupFileName
)
abstract BackupFile : 
        pszBackupFileName:string -> int
function BackupFile(
    pszBackupFileName : String
) : int

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:

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.

.NET Framework Security

See Also

Reference

IVsFileBackup Interface

Microsoft.VisualStudio.TextManager.Interop Namespace