IVsUIHierWinClipboardHelper.AdviseClipboardHelperEvents Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

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

Int32

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

Share via