IVsFileChangeEx.AdviseDirChange Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Enables a client to receive notifications of changes to a directory.

public:
 int AdviseDirChange(System::String ^ pszDir, int fWatchSubDir, Microsoft::VisualStudio::Shell::Interop::IVsFileChangeEvents ^ pFCE, [Runtime::InteropServices::Out] System::UInt32 % pvsCookie);

int AdviseDirChange(std::wstring const & pszDir, int fWatchSubDir, Microsoft::VisualStudio::Shell::Interop::IVsFileChangeEvents const & pFCE, [Runtime::InteropServices::Out] unsigned int & pvsCookie);

public int AdviseDirChange (string pszDir, int fWatchSubDir, Microsoft.VisualStudio.Shell.Interop.IVsFileChangeEvents pFCE, out uint pvsCookie);

abstract member AdviseDirChange : string * int * Microsoft.VisualStudio.Shell.Interop.IVsFileChangeEvents * uint32 -> int

Public Function AdviseDirChange (pszDir As String, fWatchSubDir As Integer, pFCE As IVsFileChangeEvents, ByRef pvsCookie As UInteger) As Integer

Parameters

pszDir

String

[in] String form of the moniker identifier of the directory in the project system.

fWatchSubDir

Int32

[in] If true, then events should also be fired for changes to sub directories. If false, then events should not be fired for changes to sub directories.

pFCE

IVsFileChangeEvents

[in] IVsFileChangeEvents Interface on the object requesting notification of file change events.

pvsCookie

UInt32

[out] Unique identifier for the file that is associated with the event sink.

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::AdviseDirChange(  
   [in] LPCOLESTR pszDir,  
   [in] BOOL fWatchSubDir,  
   [in] IVsFileChangeEvents *pFCE,  
   [out] VSCOOKIE *pvsCookie  
);