IVsFileChangeEx.IgnoreFile(UInt32, String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Ignores changes to a file.

public:
 int IgnoreFile(System::UInt32 VSCOOKIE, System::String ^ pszMkDocument, int fIgnore);

public:
 int IgnoreFile(unsigned int VSCOOKIE, Platform::String ^ pszMkDocument, int fIgnore);

int IgnoreFile(unsigned int VSCOOKIE, std::wstring const & pszMkDocument, int fIgnore);

public int IgnoreFile (uint VSCOOKIE, string pszMkDocument, int fIgnore);

abstract member IgnoreFile : uint32 * string * int -> int

Public Function IgnoreFile (VSCOOKIE As UInteger, pszMkDocument As String, fIgnore As Integer) As Integer

Parameters

VSCOOKIE: UInt32

[in] A VSCOOKIE that identifies the file. If you use this parameter to specify the file, then pszMkDocument must be set to null.

pszMkDocument: String

[in] String form of the moniker identifier of the document in the project system. In the case of documents that are files, this is always the path to the file. If you use this parameter to specify the file, then vsCookie must be set to null.

fIgnore: Int32

[in] If true, then ignore the file changes. If false, then do not ignore the file changes.

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 IVsFileChangeEx::IgnoreFile(  
   [in] VSCOOKIE vsCookie,  
   [in] LPCOLESTR pszMkDocument,  
   [in] BOOL fIgnore  
);

Use either the vsCookie or pszMkDocument parameter to specify the file. If both parameters are used, E_INVALIDARG is returned.

Applies to