Share via


RunningDocumentTable.Advise Method

Enables the client to receive events about changes to the Running Document Table (RDT).

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Function Advise ( _
    sink As IVsRunningDocTableEvents _
) As UInteger
[CLSCompliantAttribute(false)]
public uint Advise(
    IVsRunningDocTableEvents sink
)
[CLSCompliantAttribute(false)]
public:
unsigned int Advise(
    IVsRunningDocTableEvents^ sink
)
[<CLSCompliantAttribute(false)>]
member Advise : 
        sink:IVsRunningDocTableEvents -> uint32 
public function Advise(
    sink : IVsRunningDocTableEvents
) : uint

Parameters

Return Value

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

See Also

Reference

RunningDocumentTable Class

Microsoft.VisualStudio.Shell Namespace