IVsRunningDocumentTable.AdviseRunningDocTableEvents Method

Definition

Enables the client to receive notifications of changes to the Running Document Table (RDT).

int AdviseRunningDocTableEvents(Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents const & pSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

Parameters

pSink
IVsRunningDocTableEvents

[in] The IVsRunningDocTableEvents interface that receives the event notifications.

pdwCookie
UInt32

[out] Returns an abstract value that identifies the client to be advised of RDT events. Use this cookie later in a call to the UnadviseRunningDocTableEvents(UInt32) method.

Returns

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

Remarks

This method is safe to access from any thread.

Applies to