IVsHierarchy.AdviseHierarchyEvents(IVsHierarchyEvents, UInt32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

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

public:
 int AdviseHierarchyEvents(Microsoft::VisualStudio::Shell::Interop::IVsHierarchyEvents ^ pEventSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseHierarchyEvents(Microsoft::VisualStudio::Shell::Interop::IVsHierarchyEvents const & pEventSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseHierarchyEvents (Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents pEventSink, out uint pdwCookie);

abstract member AdviseHierarchyEvents : Microsoft.VisualStudio.Shell.Interop.IVsHierarchyEvents * uint32 -> int

Public Function AdviseHierarchyEvents (pEventSink As IVsHierarchyEvents, ByRef pdwCookie As UInteger) As Integer

Parameters

pEventSink

IVsHierarchyEvents

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

pdwCookie

UInt32

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

Returns

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  
);