IVsShell.AdviseBroadcastMessages Method

Article
03/06/2013

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

'Declaration
Function AdviseBroadcastMessages ( _
    pSink As IVsBroadcastMessageEvents, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

int AdviseBroadcastMessages(
    IVsBroadcastMessageEvents pSink,
    out uint pdwCookie
)

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

abstract AdviseBroadcastMessages : 
        pSink:IVsBroadcastMessageEvents * 
        pdwCookie:uint32 byref -> int

function AdviseBroadcastMessages(
    pSink : IVsBroadcastMessageEvents, 
    pdwCookie : uint
) : int

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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.