IVsRunningDocumentTable.AdviseRunningDocTableEvents Method (IVsRunningDocTableEvents, UInt32)

 

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

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

abstract AdviseRunningDocTableEvents : 
        pSink:IVsRunningDocTableEvents *
        pdwCookie:uint32 byref -> int

Parameters

pSink
Type: Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents

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

pdwCookie
Type: System.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 method.

Return Value

Type: System.Int32

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

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.

Return to top
Show: