RunningDocumentTable.Advise(IVsRunningDocTableEvents) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.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 events about changes to the Running Document Table (RDT).

public:
 System::UInt32 Advise(Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents ^ sink);

public:
 unsigned int Advise(Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents ^ sink);

unsigned int Advise(Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents const & sink);

public uint Advise (Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents sink);

member this.Advise : Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents -> uint32

Public Function Advise (sink As IVsRunningDocTableEvents) As UInteger

Parameters

sink: IVsRunningDocTableEvents

[in] An IVsRunningDocTableEvents object representing an entity to be called for various running document table events.

Returns

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.

Applies to