IVsRunningDocumentTable.AdviseRunningDocTableEvents Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int AdviseRunningDocTableEvents(Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents ^ pSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

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

public int AdviseRunningDocTableEvents (Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents pSink, out uint pdwCookie);

abstract member AdviseRunningDocTableEvents : Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents * uint32 -> int

Public Function AdviseRunningDocTableEvents (pSink As IVsRunningDocTableEvents, ByRef pdwCookie As UInteger) As Integer

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

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::AdviseRunningDocTableEvents(  
   [in] IVsRunningDocTableEvents *pSink,  
   [out] VSCOOKIE                *pdwCookie  
);

The IVsRunningDocTableEvents interface can contain additional interfaces such as IVsRunningDocTableEvents2, IVsRunningDocTableEvents3, and IVsRunningDocTableEvents4 to handle additional events. The environment calls the QueryInterface method on the IVsRunningDocTableEvents interface to obtain the other interfaces.

Applies to