Partager via


IVsDocDataFileChangeControl.IgnoreFileChanges(Int32) Method

Definition

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

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