IVsFileBackup.IsBackupFileObsolete Method

Article
03/11/2013

Sets a backup dirty bit.

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

Syntax

'Declaration
Function IsBackupFileObsolete ( _
    <OutAttribute> ByRef pbObsolete As Integer _
) As Integer

int IsBackupFileObsolete(
    out int pbObsolete
)

int IsBackupFileObsolete(
    [OutAttribute] int% pbObsolete
)

abstract IsBackupFileObsolete : 
        pbObsolete:int byref -> int

function IsBackupFileObsolete(
    pbObsolete : int
) : int

Parameters

pbObsolete
Type: System.Int32%
[out] Backup file is dirty

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::IsBackupFileObsolete(
   [out] BOOL *pbObsolete
);

IVsFileBackup needs to keep track of a secondary dirty bit for the backup in order to avoid extra backups for cases where the file is dirty, but the backup matches the current state of the object. This bit should be set when the object is modified and cleared on calls to BackupFile and any Save method. IsBackupFileObsolete returns true if this bit is set, false otherwise.

.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.

Share via