IVsShell.AdviseBroadcastMessages(IVsBroadcastMessageEvents, UInt32) 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.

Enables clients to receive messages that are typically broadcast only to the main application window.

public:
 int AdviseBroadcastMessages(Microsoft::VisualStudio::Shell::Interop::IVsBroadcastMessageEvents ^ pSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseBroadcastMessages(Microsoft::VisualStudio::Shell::Interop::IVsBroadcastMessageEvents const & pSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseBroadcastMessages (Microsoft.VisualStudio.Shell.Interop.IVsBroadcastMessageEvents pSink, out uint pdwCookie);

abstract member AdviseBroadcastMessages : Microsoft.VisualStudio.Shell.Interop.IVsBroadcastMessageEvents * uint32 -> int

Public Function AdviseBroadcastMessages (pSink As IVsBroadcastMessageEvents, ByRef pdwCookie As UInteger) As Integer

Parameters

pSink: IVsBroadcastMessageEvents

[in] Pointer to the IVsBroadcastMessageEvents interface. You will receive notification of its implementation.

pdwCookie: UInt32

[out] Pointer to an abstract handle required to unadvise the client of broadcast messages in the environment.

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 IVsShell::AdviseBroadcastMessages(  
   [in] IVsBroadcastMessageEvents *pSink,  
   [out] VSCOOKIE *pdwCookie  
);

This method allows clients to receive specific messages typically broadcast only to the main environment window. These messages include system messages, such as color palette and font changes.

Applies to

Share via