IVsHierarchy.AdviseHierarchyEvents Method

Article
04/22/2008

Establishes client notification of hierarchy events without the hierarchy implementing IConnectionPointContainer.

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

Syntax

'Déclaration
Function AdviseHierarchyEvents ( _
    pEventSink As IVsHierarchyEvents, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer
'Utilisation
Dim instance As IVsHierarchy
Dim pEventSink As IVsHierarchyEvents
Dim pdwCookie As UInteger
Dim returnValue As Integer

returnValue = instance.AdviseHierarchyEvents(pEventSink, _
    pdwCookie)

int AdviseHierarchyEvents(
    IVsHierarchyEvents pEventSink,
    out uint pdwCookie
)

int AdviseHierarchyEvents(
    [InAttribute] IVsHierarchyEvents^ pEventSink, 
    [OutAttribute] unsigned int% pdwCookie
)

function AdviseHierarchyEvents(
    pEventSink : IVsHierarchyEvents, 
    pdwCookie : uint
) : int

Parameters

pEventSink
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents

[in] IVsHierarchyEvents interface on the object requesting notification of hierarchy events.

pdwCookie
Type: System.UInt32%

[out] Pointer to a unique identifier for the referenced event sink. This value is required to unadvise the event sink using UnadviseHierarchyEvents.

Return Value

Type: System.Int32

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

Remarks

Use this method to set up notification of hierarchy events on a particular object by synchronizing the hierarchy window to the hierarchy events. For example, when you add an item in the Solution Explorer window, the hierarchy to which the item is added notifies the listener that has registered as a sink for the event. Based on this event, the Solution Explorer window can then add the new item to the hierarchy.

COM Signature

From vsshell.idl:

HRESULT IVsHierarchy::AdviseHierarchyEvents(
   [in] IVsHierarchyEvents *pEventSink,
   [out] VSCOOKIE *pdwCookie
);

Permissions

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.

Partager via