Win32 API 日本語リファレンス
ホームSystem.StationsAndDesktops › BroadcastSystemMessageW

BroadcastSystemMessageW

関数
システム内の指定受信者へメッセージを送信する。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT BroadcastSystemMessageW(
    BROADCAST_SYSTEM_MESSAGE_FLAGS flags,
    BROADCAST_SYSTEM_MESSAGE_INFO* lpInfo,   // optional
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam
);

パラメーター

名前方向説明
flagsBROADCAST_SYSTEM_MESSAGE_FLAGSinブロードキャスト動作を制御するフラグ。BSF_QUERY 等。
lpInfoBROADCAST_SYSTEM_MESSAGE_INFO*inoutoptional送信先を指定し結果を受け取るフラグへのポインタ。NULL で全コンポーネント。
MsgDWORDin送信するメッセージ識別子(ウィンドウメッセージ)。
wParamWPARAMinメッセージに付随する WPARAM 値。
lParamLPARAMinメッセージに付随する LPARAM 値。

戻り値の型: INT

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT BroadcastSystemMessageW(
    BROADCAST_SYSTEM_MESSAGE_FLAGS flags,
    BROADCAST_SYSTEM_MESSAGE_INFO* lpInfo,   // optional
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int BroadcastSystemMessageW(
    uint flags,   // BROADCAST_SYSTEM_MESSAGE_FLAGS
    IntPtr lpInfo,   // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    uint Msg,   // DWORD
    UIntPtr wParam,   // WPARAM
    IntPtr lParam   // LPARAM
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BroadcastSystemMessageW(
    flags As UInteger,   ' BROADCAST_SYSTEM_MESSAGE_FLAGS
    lpInfo As IntPtr,   ' BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    Msg As UInteger,   ' DWORD
    wParam As UIntPtr,   ' WPARAM
    lParam As IntPtr   ' LPARAM
) As Integer
End Function
' flags : BROADCAST_SYSTEM_MESSAGE_FLAGS
' lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
' Msg : DWORD
' wParam : WPARAM
' lParam : LPARAM
Declare PtrSafe Function BroadcastSystemMessageW Lib "user32" ( _
    ByVal flags As Long, _
    ByVal lpInfo As LongPtr, _
    ByVal Msg As Long, _
    ByVal wParam As LongPtr, _
    ByVal lParam As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BroadcastSystemMessageW = ctypes.windll.user32.BroadcastSystemMessageW
BroadcastSystemMessageW.restype = ctypes.c_int
BroadcastSystemMessageW.argtypes = [
    wintypes.DWORD,  # flags : BROADCAST_SYSTEM_MESSAGE_FLAGS
    ctypes.c_void_p,  # lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    wintypes.DWORD,  # Msg : DWORD
    ctypes.c_size_t,  # wParam : WPARAM
    ctypes.c_ssize_t,  # lParam : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
BroadcastSystemMessageW = Fiddle::Function.new(
  lib['BroadcastSystemMessageW'],
  [
    -Fiddle::TYPE_INT,  # flags : BROADCAST_SYSTEM_MESSAGE_FLAGS
    Fiddle::TYPE_VOIDP,  # lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    -Fiddle::TYPE_INT,  # Msg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # wParam : WPARAM
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn BroadcastSystemMessageW(
        flags: u32,  // BROADCAST_SYSTEM_MESSAGE_FLAGS
        lpInfo: *mut u32,  // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
        Msg: u32,  // DWORD
        wParam: usize,  // WPARAM
        lParam: isize  // LPARAM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int BroadcastSystemMessageW(uint flags, IntPtr lpInfo, uint Msg, UIntPtr wParam, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_BroadcastSystemMessageW' -Namespace Win32 -PassThru
# $api::BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
#uselib "USER32.dll"
#func global BroadcastSystemMessageW "BroadcastSystemMessageW" wptr, wptr, wptr, wptr, wptr
; BroadcastSystemMessageW flags, varptr(lpInfo), Msg, wParam, lParam   ; 戻り値は stat
; flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> "wptr"
; lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> "wptr"
; Msg : DWORD -> "wptr"
; wParam : WPARAM -> "wptr"
; lParam : LPARAM -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global BroadcastSystemMessageW "BroadcastSystemMessageW" int, var, int, sptr, sptr
; res = BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
; flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> "int"
; lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> "var"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT BroadcastSystemMessageW(BROADCAST_SYSTEM_MESSAGE_FLAGS flags, BROADCAST_SYSTEM_MESSAGE_INFO* lpInfo, DWORD Msg, WPARAM wParam, LPARAM lParam)
#uselib "USER32.dll"
#cfunc global BroadcastSystemMessageW "BroadcastSystemMessageW" int, var, int, intptr, intptr
; res = BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
; flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> "int"
; lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> "var"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "intptr"
; lParam : LPARAM -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procBroadcastSystemMessageW = user32.NewProc("BroadcastSystemMessageW")
)

// flags (BROADCAST_SYSTEM_MESSAGE_FLAGS), lpInfo (BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out), Msg (DWORD), wParam (WPARAM), lParam (LPARAM)
r1, _, err := procBroadcastSystemMessageW.Call(
	uintptr(flags),
	uintptr(lpInfo),
	uintptr(Msg),
	uintptr(wParam),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function BroadcastSystemMessageW(
  flags: DWORD;   // BROADCAST_SYSTEM_MESSAGE_FLAGS
  lpInfo: Pointer;   // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
  Msg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt   // LPARAM
): Integer; stdcall;
  external 'USER32.dll' name 'BroadcastSystemMessageW';
result := DllCall("USER32\BroadcastSystemMessageW"
    , "UInt", flags   ; BROADCAST_SYSTEM_MESSAGE_FLAGS
    , "Ptr", lpInfo   ; BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    , "UInt", Msg   ; DWORD
    , "UPtr", wParam   ; WPARAM
    , "Ptr", lParam   ; LPARAM
    , "Int")   ; return: INT
●BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam) = DLL("USER32.dll", "int BroadcastSystemMessageW(dword, void*, dword, int, int)")
# 呼び出し: BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
# flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> "dword"
# lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> "void*"
# Msg : DWORD -> "dword"
# wParam : WPARAM -> "int"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn BroadcastSystemMessageW(
    flags: u32, // BROADCAST_SYSTEM_MESSAGE_FLAGS
    lpInfo: [*c]u32, // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    Msg: u32, // DWORD
    wParam: usize, // WPARAM
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc BroadcastSystemMessageW(
    flags: uint32,  # BROADCAST_SYSTEM_MESSAGE_FLAGS
    lpInfo: ptr uint32,  # BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    Msg: uint32,  # DWORD
    wParam: uint,  # WPARAM
    lParam: int  # LPARAM
): int32 {.importc: "BroadcastSystemMessageW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int BroadcastSystemMessageW(
    uint flags,   // BROADCAST_SYSTEM_MESSAGE_FLAGS
    uint* lpInfo,   // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    uint Msg,   // DWORD
    size_t wParam,   // WPARAM
    ptrdiff_t lParam   // LPARAM
);
ccall((:BroadcastSystemMessageW, "USER32.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt32}, UInt32, Csize_t, Int),
      flags, lpInfo, Msg, wParam, lParam)
# flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> UInt32
# lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> Ptr{UInt32}
# Msg : DWORD -> UInt32
# wParam : WPARAM -> Csize_t
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t BroadcastSystemMessageW(
    uint32_t flags,
    uint32_t* lpInfo,
    uint32_t Msg,
    uintptr_t wParam,
    intptr_t lParam);
]]
local user32 = ffi.load("user32")
-- user32.BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
-- flags : BROADCAST_SYSTEM_MESSAGE_FLAGS
-- lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
-- Msg : DWORD
-- wParam : WPARAM
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const BroadcastSystemMessageW = lib.func('__stdcall', 'BroadcastSystemMessageW', 'int32_t', ['uint32_t', 'uint32_t *', 'uint32_t', 'uintptr_t', 'intptr_t']);
// BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
// flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> 'uint32_t'
// lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> 'uint32_t *'
// Msg : DWORD -> 'uint32_t'
// wParam : WPARAM -> 'uintptr_t'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  BroadcastSystemMessageW: { parameters: ["u32", "pointer", "u32", "usize", "isize"], result: "i32" },
});
// lib.symbols.BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam)
// flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> "u32"
// lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> "pointer"
// Msg : DWORD -> "u32"
// wParam : WPARAM -> "usize"
// lParam : LPARAM -> "isize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BroadcastSystemMessageW(
    uint32_t flags,
    uint32_t* lpInfo,
    uint32_t Msg,
    size_t wParam,
    intptr_t lParam);
C, "USER32.dll");
// $ffi->BroadcastSystemMessageW(flags, lpInfo, Msg, wParam, lParam);
// flags : BROADCAST_SYSTEM_MESSAGE_FLAGS
// lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
// Msg : DWORD
// wParam : WPARAM
// lParam : LPARAM
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    int BroadcastSystemMessageW(
        int flags,   // BROADCAST_SYSTEM_MESSAGE_FLAGS
        IntByReference lpInfo,   // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
        int Msg,   // DWORD
        long wParam,   // WPARAM
        long lParam   // LPARAM
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun BroadcastSystemMessageW = BroadcastSystemMessageW(
    flags : UInt32,   # BROADCAST_SYSTEM_MESSAGE_FLAGS
    lpInfo : UInt32*,   # BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
    Msg : UInt32,   # DWORD
    wParam : LibC::SizeT,   # WPARAM
    lParam : LibC::SSizeT   # LPARAM
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BroadcastSystemMessageWNative = Int32 Function(Uint32, Pointer<Uint32>, Uint32, UintPtr, IntPtr);
typedef BroadcastSystemMessageWDart = int Function(int, Pointer<Uint32>, int, int, int);
final BroadcastSystemMessageW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<BroadcastSystemMessageWNative, BroadcastSystemMessageWDart>('BroadcastSystemMessageW');
// flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> Uint32
// lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> Pointer<Uint32>
// Msg : DWORD -> Uint32
// wParam : WPARAM -> UintPtr
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BroadcastSystemMessageW(
  flags: DWORD;   // BROADCAST_SYSTEM_MESSAGE_FLAGS
  lpInfo: Pointer;   // BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
  Msg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt   // LPARAM
): Integer; stdcall;
  external 'USER32.dll' name 'BroadcastSystemMessageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BroadcastSystemMessageW"
  c_BroadcastSystemMessageW :: Word32 -> Ptr Word32 -> Word32 -> CUIntPtr -> CIntPtr -> IO Int32
-- flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> Word32
-- lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> Ptr Word32
-- Msg : DWORD -> Word32
-- wParam : WPARAM -> CUIntPtr
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let broadcastsystemmessagew =
  foreign "BroadcastSystemMessageW"
    (uint32_t @-> (ptr uint32_t) @-> uint32_t @-> size_t @-> intptr_t @-> returning int32_t)
(* flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> uint32_t *)
(* lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> (ptr uint32_t) *)
(* Msg : DWORD -> uint32_t *)
(* wParam : WPARAM -> size_t *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("BroadcastSystemMessageW" broadcast-system-message-w :convention :stdcall) :int32
  (flags :uint32)   ; BROADCAST_SYSTEM_MESSAGE_FLAGS
  (lp-info :pointer)   ; BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out
  (msg :uint32)   ; DWORD
  (w-param :uint64)   ; WPARAM
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BroadcastSystemMessageW = Win32::API::More->new('USER32',
    'int BroadcastSystemMessageW(DWORD flags, LPVOID lpInfo, DWORD Msg, WPARAM wParam, LPARAM lParam)');
# my $ret = $BroadcastSystemMessageW->Call($flags, $lpInfo, $Msg, $wParam, $lParam);
# flags : BROADCAST_SYSTEM_MESSAGE_FLAGS -> DWORD
# lpInfo : BROADCAST_SYSTEM_MESSAGE_INFO* optional, in/out -> LPVOID
# Msg : DWORD -> DWORD
# wParam : WPARAM -> WPARAM
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型