This documentation is archived and is not being maintained.

IVsHierarchy.AdviseHierarchyEvents Method

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)

int AdviseHierarchyEvents (
	[InAttribute] IVsHierarchyEvents pEventSink,
	out uint pdwCookie
)
int AdviseHierarchyEvents (
	/** @attribute InAttribute() */ IVsHierarchyEvents pEventSink, 
	/** @attribute OutAttribute() */ /** @ref */ UInt32 pdwCookie
)
JScript does not support passing value-type arguments by reference.

Parameters

pEventSink

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

pdwCookie

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

Return Value

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

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