DocData.BackupFile Method

Make a single file backup of this document. Returns whether the document is expected to re-load without data loss.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Protected Overridable Function BackupFile ( _
    backupFileName As String _
) As Boolean

protected virtual bool BackupFile(
    string backupFileName
)

protected:
virtual bool BackupFile(
    String^ backupFileName
)

abstract BackupFile : 
        backupFileName:string -> bool  
override BackupFile : 
        backupFileName:string -> bool

protected function BackupFile(
    backupFileName : String
) : boolean

Parameters

• backupFileName
  Type: String

  File name where the backup should be stored.

Return Value

Type: Boolean

Remarks

When overriding this method, raise an exception if there are any save errors. If there are validation errors that indicate that the file might be unreadable when it is reloaded, return false.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace