IVsTrackProjectDocuments2::AdviseTrackProjectDocumentsEvents Method (IVsTrackProjectDocumentsEvents2^, UInt32)

Visual Studio 2015

This method enables clients to receive notifications of project documents events.

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

Syntax

C++

int AdviseTrackProjectDocumentsEvents(
	IVsTrackProjectDocumentsEvents2^ pEventSink,
	[OutAttribute] unsigned int% pdwCookie
)

Parameters

pEventSink: Type: Microsoft.VisualStudio.Shell.Interop::IVsTrackProjectDocumentsEvents2^
[in] Pointer to the IVsTrackProjectDocumentsEvents2 interface.

pdwCookie: Type: System::UInt32
[out] Pointer to an abstract handle that identifies the client to be advised of project documents events.

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 IVsTrackProjectDocuments2.idl

C++

HRESULT IVsTrackProjectDocuments2::AdviseTrackProjectDocumentsEvents(
   [in] IVsTrackProjectDocumentsEvents2 *pEventSink,
   [out] VSCOOKIE *pdwCookie
);

The pdwCookie parameter is passed in with a call to UnadviseTrackProjectDocumentsEvents when the client wants to be unadvised of these events.