IVsFileBackup::IsBackupFileObsolete Method (Int32)

Visual Studio 2015

Sets a backup dirty bit.

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

Syntax

C++

int IsBackupFileObsolete(
	[OutAttribute] int% pbObsolete
)

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:

C++

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.