Share via


IVsShell.AdviseBroadcastMessages(IVsBroadcastMessageEvents, UInt32) Method

Definition

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

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