IVsShell::AdviseBroadcastMessages Method (IVsBroadcastMessageEvents^, UInt32)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int AdviseBroadcastMessages(
	IVsBroadcastMessageEvents^ pSink,
	[OutAttribute] unsigned int% pdwCookie
)

Parameters

pSink: Type: Microsoft.VisualStudio.Shell.Interop::IVsBroadcastMessageEvents^
[in] Pointer to the IVsBroadcastMessageEvents interface. You will receive notification of its implementation.

pdwCookie: Type: System::UInt32
[out] Pointer to an abstract handle required to unadvise the client of broadcast messages in the environment.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell.idl:

C++

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.