RunningDocumentTable.Advise Method
Enables the client to receive events about changes to the Running Document Table (RDT).
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Public Function Advise ( _
sink As IVsRunningDocTableEvents _
) As UInteger
public uint Advise(
IVsRunningDocTableEvents sink
)
public:
unsigned int Advise(
IVsRunningDocTableEvents^ sink
)
member Advise :
sink:IVsRunningDocTableEvents -> uint32
public function Advise(
sink : IVsRunningDocTableEvents
) : uint
Parameters
sink
Type: Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents[in] An IVsRunningDocTableEvents object representing an entity to be called for various running document table events.
Return Value
Type: UInt32
A cookie associated with the given IVsRunningDocTableEvents object. If an error occurs, this method throws an exception.
Remarks
This method forwards the call to the AdviseRunningDocTableEvents method in the IVsRunningDocumentTable interface. The returned cookie can be passed to the Unadvise method to remove the IVsRunningDocTableEvents object from the list of entities to be notified.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.