Share via


IVsBroadcastMessageEvents.OnBroadcastMessage Method

Fires when a message is broadcast to the environment window.

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

Syntax

'Declaration
Function OnBroadcastMessage ( _
    msg As UInteger, _
    wParam As IntPtr, _
    lParam As IntPtr _
) As Integer
int OnBroadcastMessage(
    uint msg,
    IntPtr wParam,
    IntPtr lParam
)
int OnBroadcastMessage(
    [InAttribute] unsigned int msg, 
    [InAttribute] IntPtr wParam, 
    [InAttribute] IntPtr lParam
)
abstract OnBroadcastMessage : 
        msg:uint32 * 
        wParam:IntPtr * 
        lParam:IntPtr -> int
function OnBroadcastMessage(
    msg : uint, 
    wParam : IntPtr, 
    lParam : IntPtr
) : int

Parameters

  • msg
    Type: System.UInt32

    [in] Specifies the notification message.

  • wParam
    Type: System.IntPtr

    [in] Word value parameter for the Windows message, as received by the environment.

  • lParam
    Type: System.IntPtr

    [in] Long integer parameter for the Windows message, as received by 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 IVsBroadcastMessageEvents::OnBroadcastMessage(
   [in] UINT msg,
   [in] WPARAM wParam,
   [in] LPARAM lParam
);

Messages that are currently passed include:

  • WM_WININICHANGE

  • WM_DISPLAYCHANGE

  • WM_SYSCOLORCHANGE

  • WM_PALETTECHANGED

  • WM_PALETTEISCHANGING

  • WM_ACTIVATEAPP

.NET Framework Security

See Also

Reference

IVsBroadcastMessageEvents Interface

Microsoft.VisualStudio.Shell.Interop Namespace