Win32 API 日本語リファレンス
ホームUI.Shell › SHSendMessageBroadcastW

SHSendMessageBroadcastW

関数
全トップレベルウィンドウへメッセージをブロードキャストする。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

LRESULT SHSendMessageBroadcastW(
    DWORD uMsg,
    WPARAM wParam,
    LPARAM lParam
);

パラメーター

名前方向説明
uMsgDWORDin送信するメッセージ。
wParamWPARAMinメッセージ固有の追加情報。
lParamLPARAMinメッセージ固有の追加情報。

戻り値の型: LRESULT

公式ドキュメント

システム内のすべてのトップレベルウィンドウにメッセージを送信します。(Unicode)

戻り値

Type: LRESULT

戻り値に意味はありません。

解説(Remarks)

SHSendMessageBroadcast は、HWND_BROADCAST を指定した SendMessage と同等です。メッセージに応答しないウィンドウがシステム内に存在し得る場合に Shell が応答不能になるのを避けるには、SHSendMessageBroadcast を使用してください。

SHSendMessageBroadcast は名前ではエクスポートされません。SHSendMessageBroadcastA は Shlwapi.dll から序数 432 としてエクスポートされます。SHSendMessageBroadcastW は Shlwapi.dll から序数 433 としてエクスポートされます。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHSendMessageBroadcast を定義しています。エンコード中立のエイリアスと、エンコード中立でないコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

LRESULT SHSendMessageBroadcastW(
    DWORD uMsg,
    WPARAM wParam,
    LPARAM lParam
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr SHSendMessageBroadcastW(
    uint uMsg,   // DWORD
    UIntPtr wParam,   // WPARAM
    IntPtr lParam   // LPARAM
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHSendMessageBroadcastW(
    uMsg As UInteger,   ' DWORD
    wParam As UIntPtr,   ' WPARAM
    lParam As IntPtr   ' LPARAM
) As IntPtr
End Function
' uMsg : DWORD
' wParam : WPARAM
' lParam : LPARAM
Declare PtrSafe Function SHSendMessageBroadcastW Lib "shlwapi" ( _
    ByVal uMsg As Long, _
    ByVal wParam As LongPtr, _
    ByVal lParam As LongPtr) As LongPtr
' 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

SHSendMessageBroadcastW = ctypes.windll.shlwapi.SHSendMessageBroadcastW
SHSendMessageBroadcastW.restype = ctypes.c_ssize_t
SHSendMessageBroadcastW.argtypes = [
    wintypes.DWORD,  # uMsg : DWORD
    ctypes.c_size_t,  # wParam : WPARAM
    ctypes.c_ssize_t,  # lParam : LPARAM
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHSendMessageBroadcastW = Fiddle::Function.new(
  lib['SHSendMessageBroadcastW'],
  [
    -Fiddle::TYPE_INT,  # uMsg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # wParam : WPARAM
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn SHSendMessageBroadcastW(
        uMsg: u32,  // DWORD
        wParam: usize,  // WPARAM
        lParam: isize  // LPARAM
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr SHSendMessageBroadcastW(uint uMsg, UIntPtr wParam, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHSendMessageBroadcastW' -Namespace Win32 -PassThru
# $api::SHSendMessageBroadcastW(uMsg, wParam, lParam)
#uselib "SHLWAPI.dll"
#func global SHSendMessageBroadcastW "SHSendMessageBroadcastW" wptr, wptr, wptr
; SHSendMessageBroadcastW uMsg, wParam, lParam   ; 戻り値は stat
; uMsg : DWORD -> "wptr"
; wParam : WPARAM -> "wptr"
; lParam : LPARAM -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHSendMessageBroadcastW "SHSendMessageBroadcastW" int, sptr, sptr
; res = SHSendMessageBroadcastW(uMsg, wParam, lParam)
; uMsg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; LRESULT SHSendMessageBroadcastW(DWORD uMsg, WPARAM wParam, LPARAM lParam)
#uselib "SHLWAPI.dll"
#cfunc global SHSendMessageBroadcastW "SHSendMessageBroadcastW" int, intptr, intptr
; res = SHSendMessageBroadcastW(uMsg, wParam, lParam)
; uMsg : DWORD -> "int"
; wParam : WPARAM -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHSendMessageBroadcastW = shlwapi.NewProc("SHSendMessageBroadcastW")
)

// uMsg (DWORD), wParam (WPARAM), lParam (LPARAM)
r1, _, err := procSHSendMessageBroadcastW.Call(
	uintptr(uMsg),
	uintptr(wParam),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LRESULT
function SHSendMessageBroadcastW(
  uMsg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'SHLWAPI.dll' name 'SHSendMessageBroadcastW';
result := DllCall("SHLWAPI\SHSendMessageBroadcastW"
    , "UInt", uMsg   ; DWORD
    , "UPtr", wParam   ; WPARAM
    , "Ptr", lParam   ; LPARAM
    , "Ptr")   ; return: LRESULT
●SHSendMessageBroadcastW(uMsg, wParam, lParam) = DLL("SHLWAPI.dll", "int SHSendMessageBroadcastW(dword, int, int)")
# 呼び出し: SHSendMessageBroadcastW(uMsg, wParam, lParam)
# uMsg : 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 "shlwapi" fn SHSendMessageBroadcastW(
    uMsg: u32, // DWORD
    wParam: usize, // WPARAM
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHSendMessageBroadcastW(
    uMsg: uint32,  # DWORD
    wParam: uint,  # WPARAM
    lParam: int  # LPARAM
): int {.importc: "SHSendMessageBroadcastW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
ptrdiff_t SHSendMessageBroadcastW(
    uint uMsg,   // DWORD
    size_t wParam,   // WPARAM
    ptrdiff_t lParam   // LPARAM
);
ccall((:SHSendMessageBroadcastW, "SHLWAPI.dll"), stdcall, Int,
      (UInt32, Csize_t, Int),
      uMsg, wParam, lParam)
# uMsg : 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[[
intptr_t SHSendMessageBroadcastW(
    uint32_t uMsg,
    uintptr_t wParam,
    intptr_t lParam);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHSendMessageBroadcastW(uMsg, wParam, lParam)
-- uMsg : 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('SHLWAPI.dll');
const SHSendMessageBroadcastW = lib.func('__stdcall', 'SHSendMessageBroadcastW', 'intptr_t', ['uint32_t', 'uintptr_t', 'intptr_t']);
// SHSendMessageBroadcastW(uMsg, wParam, lParam)
// uMsg : DWORD -> 'uint32_t'
// wParam : WPARAM -> 'uintptr_t'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHSendMessageBroadcastW: { parameters: ["u32", "usize", "isize"], result: "isize" },
});
// lib.symbols.SHSendMessageBroadcastW(uMsg, wParam, lParam)
// uMsg : 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
intptr_t SHSendMessageBroadcastW(
    uint32_t uMsg,
    size_t wParam,
    intptr_t lParam);
C, "SHLWAPI.dll");
// $ffi->SHSendMessageBroadcastW(uMsg, wParam, lParam);
// uMsg : 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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    long SHSendMessageBroadcastW(
        int uMsg,   // DWORD
        long wParam,   // WPARAM
        long lParam   // LPARAM
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHSendMessageBroadcastW = SHSendMessageBroadcastW(
    uMsg : UInt32,   # DWORD
    wParam : LibC::SizeT,   # WPARAM
    lParam : LibC::SSizeT   # LPARAM
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHSendMessageBroadcastWNative = IntPtr Function(Uint32, UintPtr, IntPtr);
typedef SHSendMessageBroadcastWDart = int Function(int, int, int);
final SHSendMessageBroadcastW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHSendMessageBroadcastWNative, SHSendMessageBroadcastWDart>('SHSendMessageBroadcastW');
// uMsg : DWORD -> Uint32
// wParam : WPARAM -> UintPtr
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHSendMessageBroadcastW(
  uMsg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'SHLWAPI.dll' name 'SHSendMessageBroadcastW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHSendMessageBroadcastW"
  c_SHSendMessageBroadcastW :: Word32 -> CUIntPtr -> CIntPtr -> IO CIntPtr
-- uMsg : DWORD -> Word32
-- wParam : WPARAM -> CUIntPtr
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shsendmessagebroadcastw =
  foreign "SHSendMessageBroadcastW"
    (uint32_t @-> size_t @-> intptr_t @-> returning intptr_t)
(* uMsg : DWORD -> uint32_t *)
(* wParam : WPARAM -> size_t *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHSendMessageBroadcastW" shsend-message-broadcast-w :convention :stdcall) :int64
  (u-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 $SHSendMessageBroadcastW = Win32::API::More->new('SHLWAPI',
    'LPARAM SHSendMessageBroadcastW(DWORD uMsg, WPARAM wParam, LPARAM lParam)');
# my $ret = $SHSendMessageBroadcastW->Call($uMsg, $wParam, $lParam);
# uMsg : DWORD -> DWORD
# wParam : WPARAM -> WPARAM
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い