IVsDocDataFileChangeControl.IgnoreFileChanges(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Determines whether changes to DocData in files should be ignored.

public:
 int IgnoreFileChanges(int fIgnore);

public:
 int IgnoreFileChanges(int fIgnore);

int IgnoreFileChanges(int fIgnore);

public int IgnoreFileChanges (int fIgnore);

abstract member IgnoreFileChanges : int -> int

Public Function IgnoreFileChanges (fIgnore As Integer) As Integer

Parameters

fIgnore: Int32

[in] true indicates that the file changes should be ignored.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsDocDataFileChangeControl::IgnoreFileChanges(  
   [in] BOOL fIgnore  
);

Document data objects that advise for FileChange notifications to automatically reload when the file has been changed outside of the editor must implement IVsDocDataFileChangeControl. The IgnoreFileChanges method when set to true tells the document data object to increment a flag to ignore IVsFileChangeEvents for the file.

This IgnoreFileChanges mechanism should be reference-counted to allow nested calls.

Applies to

Share via