Share via


IVsUIHierWinClipboardHelper.AdviseClipboardHelperEvents Method

Definition

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

public:
 int AdviseClipboardHelperEvents(Microsoft::VisualStudio::Shell::Interop::IVsUIHierWinClipboardHelperEvents ^ pSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);
int AdviseClipboardHelperEvents(Microsoft::VisualStudio::Shell::Interop::IVsUIHierWinClipboardHelperEvents const & pSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);
public int AdviseClipboardHelperEvents (Microsoft.VisualStudio.Shell.Interop.IVsUIHierWinClipboardHelperEvents pSink, out uint pdwCookie);
abstract member AdviseClipboardHelperEvents : Microsoft.VisualStudio.Shell.Interop.IVsUIHierWinClipboardHelperEvents * uint32 -> int
Public Function AdviseClipboardHelperEvents (pSink As IVsUIHierWinClipboardHelperEvents, ByRef pdwCookie As UInteger) As Integer

Parameters

pSink
IVsUIHierWinClipboardHelperEvents

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

pdwCookie
UInt32

[out] Unique identifier for the referenced event sink. This value is required to unadvise the event sink using UnadviseClipboardHelperEvents(UInt32).

Returns

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIHierWinClipboardHelper::AdviseClipboardHelperEvents(  
   [in] IVsUIHierWinClipboardHelperEvents *pSink,  
   [out] VSCOOKIE *pdwCookie  
);  

Use this method to set up notification of hierarchy events related to the clipboard by sinking the hierarchy window to the hierarchy events.

Applies to