IVsFileBackup.IsBackupFileObsolete(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets a backup dirty bit.

public:
 int IsBackupFileObsolete([Runtime::InteropServices::Out] int % pbObsolete);

int IsBackupFileObsolete([Runtime::InteropServices::Out] int & pbObsolete);

public int IsBackupFileObsolete (out int pbObsolete);

abstract member IsBackupFileObsolete : int -> int

Public Function IsBackupFileObsolete (ByRef pbObsolete As Integer) As Integer

Parameters

pbObsolete: Int32

[out] Backup file is dirty

Returns

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.

Applies to

Share via