Share via


IVsFileChangeEx.IgnoreFile Method

Ignores changes to a file.

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

Syntax

'Declaration
Function IgnoreFile ( _
    VSCOOKIE As UInteger, _
    pszMkDocument As String, _
    fIgnore As Integer _
) As Integer
int IgnoreFile(
    uint VSCOOKIE,
    string pszMkDocument,
    int fIgnore
)
int IgnoreFile(
    [InAttribute] unsigned int VSCOOKIE, 
    [InAttribute] String^ pszMkDocument, 
    [InAttribute] int fIgnore
)
abstract IgnoreFile : 
        VSCOOKIE:uint32 * 
        pszMkDocument:string * 
        fIgnore:int -> int
function IgnoreFile(
    VSCOOKIE : uint, 
    pszMkDocument : String, 
    fIgnore : int
) : int

Parameters

  • VSCOOKIE
    Type: UInt32

    [in] A VSCOOKIE that identifies the file. If you use this parameter to specify the file, then pszMkDocument must be set to nulla null reference (Nothing in Visual Basic).

  • pszMkDocument
    Type: 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 nulla null reference (Nothing in Visual Basic).

  • fIgnore
    Type: Int32

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

Return Value

Type: 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.

.NET Framework Security

See Also

Reference

IVsFileChangeEx Interface

Microsoft.VisualStudio.Shell.Interop Namespace