IVsDocDataFileChangeControl::IgnoreFileChanges Method (Int32)

Visual Studio 2015

Determines whether changes to DocData in files should be ignored.

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

Syntax

C++

int IgnoreFileChanges(
	int fIgnore
)

Parameters

fIgnore: Type: System::Int32
[in] true indicates that the file changes should be ignored.

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 vsshell.idl:

C++

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.