IVsTrackProjectDocuments2.AdviseTrackProjectDocumentsEvents Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

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

public:
 int AdviseTrackProjectDocumentsEvents(Microsoft::VisualStudio::Shell::Interop::IVsTrackProjectDocumentsEvents2 ^ pEventSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseTrackProjectDocumentsEvents(Microsoft::VisualStudio::Shell::Interop::IVsTrackProjectDocumentsEvents2 const & pEventSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseTrackProjectDocumentsEvents (Microsoft.VisualStudio.Shell.Interop.IVsTrackProjectDocumentsEvents2 pEventSink, out uint pdwCookie);

abstract member AdviseTrackProjectDocumentsEvents : Microsoft.VisualStudio.Shell.Interop.IVsTrackProjectDocumentsEvents2 * uint32 -> int

Public Function AdviseTrackProjectDocumentsEvents (pEventSink As IVsTrackProjectDocumentsEvents2, ByRef pdwCookie As UInteger) As Integer

Parameters

pEventSink

IVsTrackProjectDocumentsEvents2

[in] Pointer to the IVsTrackProjectDocumentsEvents2 interface.

pdwCookie

UInt32

[out] Pointer to an abstract handle that identifies the client to be advised of project documents events.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From IVsTrackProjectDocuments2.idl

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.