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

SendMessageCallbackW

関数
非同期でメッセージを送りコールバックで結果を受ける(Unicode)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SendMessageCallbackW(
    HWND hWnd,
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam,
    SENDASYNCPROC lpResultCallBack,
    UINT_PTR dwData
);

パラメーター

名前方向説明
hWndHWNDinメッセージを受け取るウィンドウプロシージャを持つウィンドウへのハンドル。このパラメーターが HWND_BROADCAST ((HWND)0xffff) の場合、メッセージはシステム内のすべてのトップレベルウィンドウに送信されます。これには、無効化または非表示の所有者なしウィンドウ、オーバーラップウィンドウ、ポップアップウィンドウが含まれます。ただし、子ウィンドウには送信されません。
MsgDWORDin

送信するメッセージ。

システムが提供するメッセージの一覧については、System-Defined Messages を参照してください。

wParamWPARAMinメッセージ固有の追加情報。
lParamLPARAMinメッセージ固有の追加情報。
lpResultCallBackSENDASYNCPROCin

ウィンドウプロシージャがメッセージを処理した後にシステムが呼び出すコールバック関数へのポインター。詳細については、SendAsyncProc を参照してください。

hWndHWND_BROADCAST ((HWND)0xffff) の場合、システムは各トップレベルウィンドウごとに SendAsyncProc コールバック関数を 1 回ずつ呼び出します。

dwDataUINT_PTRinlpCallBack パラメーターで指定されたコールバック関数に渡される、アプリケーション定義の値。

戻り値の型: BOOL

公式ドキュメント

指定したメッセージを 1 つまたは複数のウィンドウに送信します。(SendMessageCallbackW)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

対象のウィンドウが呼び出し元と同じスレッドに属している場合、ウィンドウプロシージャは同期的に呼び出され、ウィンドウプロシージャが返った直後にコールバック関数が呼び出されます。対象のウィンドウが呼び出し元とは別のスレッドに属している場合、コールバック関数は、SendMessageCallback を呼び出したスレッドが GetMessagePeekMessage、または WaitMessage を呼び出したときにのみ呼び出されます。

WM_USER 未満の範囲のメッセージを非同期メッセージ関数(PostMessageSendNotifyMessage、および SendMessageCallback)に送信する場合、メッセージパラメーターにポインターを含めることはできません。そうしないと、操作は失敗します。これらの関数は受信側スレッドがメッセージを処理する機会を得る前に返り、送信側はメモリが使用される前に解放してしまいます。

HWND_BROADCAST を使用して通信する必要があるアプリケーションは、RegisterWindowMessage 関数を使用して、アプリケーション間通信用の一意のメッセージを取得してください。

システムがマーシャリングを行うのはシステムメッセージ(0 から (WM_USER-1) までの範囲のもの)のみです。その他のメッセージ(WM_USER 以上のもの)を別のプロセスに送信するには、独自のマーシャリングを行う必要があります。

メモ

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

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

各言語での呼び出し定義

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

BOOL SendMessageCallbackW(
    HWND hWnd,
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam,
    SENDASYNCPROC lpResultCallBack,
    UINT_PTR dwData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SendMessageCallbackW(
    IntPtr hWnd,   // HWND
    uint Msg,   // DWORD
    UIntPtr wParam,   // WPARAM
    IntPtr lParam,   // LPARAM
    IntPtr lpResultCallBack,   // SENDASYNCPROC
    UIntPtr dwData   // UINT_PTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SendMessageCallbackW(
    hWnd As IntPtr,   ' HWND
    Msg As UInteger,   ' DWORD
    wParam As UIntPtr,   ' WPARAM
    lParam As IntPtr,   ' LPARAM
    lpResultCallBack As IntPtr,   ' SENDASYNCPROC
    dwData As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' Msg : DWORD
' wParam : WPARAM
' lParam : LPARAM
' lpResultCallBack : SENDASYNCPROC
' dwData : UINT_PTR
Declare PtrSafe Function SendMessageCallbackW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal Msg As Long, _
    ByVal wParam As LongPtr, _
    ByVal lParam As LongPtr, _
    ByVal lpResultCallBack As LongPtr, _
    ByVal dwData 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

SendMessageCallbackW = ctypes.windll.user32.SendMessageCallbackW
SendMessageCallbackW.restype = wintypes.BOOL
SendMessageCallbackW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.DWORD,  # Msg : DWORD
    ctypes.c_size_t,  # wParam : WPARAM
    ctypes.c_ssize_t,  # lParam : LPARAM
    ctypes.c_void_p,  # lpResultCallBack : SENDASYNCPROC
    ctypes.c_size_t,  # dwData : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SendMessageCallbackW = Fiddle::Function.new(
  lib['SendMessageCallbackW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    -Fiddle::TYPE_INT,  # Msg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # wParam : WPARAM
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    Fiddle::TYPE_VOIDP,  # lpResultCallBack : SENDASYNCPROC
    Fiddle::TYPE_UINTPTR_T,  # dwData : UINT_PTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SendMessageCallbackW(
        hWnd: *mut core::ffi::c_void,  // HWND
        Msg: u32,  // DWORD
        wParam: usize,  // WPARAM
        lParam: isize,  // LPARAM
        lpResultCallBack: *const core::ffi::c_void,  // SENDASYNCPROC
        dwData: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SendMessageCallbackW(IntPtr hWnd, uint Msg, UIntPtr wParam, IntPtr lParam, IntPtr lpResultCallBack, UIntPtr dwData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SendMessageCallbackW' -Namespace Win32 -PassThru
# $api::SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
#uselib "USER32.dll"
#func global SendMessageCallbackW "SendMessageCallbackW" wptr, wptr, wptr, wptr, wptr, wptr
; SendMessageCallbackW hWnd, Msg, wParam, lParam, lpResultCallBack, dwData   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; Msg : DWORD -> "wptr"
; wParam : WPARAM -> "wptr"
; lParam : LPARAM -> "wptr"
; lpResultCallBack : SENDASYNCPROC -> "wptr"
; dwData : UINT_PTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SendMessageCallbackW "SendMessageCallbackW" sptr, int, sptr, sptr, sptr, sptr
; res = SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
; hWnd : HWND -> "sptr"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; lpResultCallBack : SENDASYNCPROC -> "sptr"
; dwData : UINT_PTR -> "sptr"
; BOOL SendMessageCallbackW(HWND hWnd, DWORD Msg, WPARAM wParam, LPARAM lParam, SENDASYNCPROC lpResultCallBack, UINT_PTR dwData)
#uselib "USER32.dll"
#cfunc global SendMessageCallbackW "SendMessageCallbackW" intptr, int, intptr, intptr, intptr, intptr
; res = SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
; hWnd : HWND -> "intptr"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "intptr"
; lParam : LPARAM -> "intptr"
; lpResultCallBack : SENDASYNCPROC -> "intptr"
; dwData : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSendMessageCallbackW = user32.NewProc("SendMessageCallbackW")
)

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

extern "user32" fn SendMessageCallbackW(
    hWnd: ?*anyopaque, // HWND
    Msg: u32, // DWORD
    wParam: usize, // WPARAM
    lParam: isize, // LPARAM
    lpResultCallBack: ?*anyopaque, // SENDASYNCPROC
    dwData: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SendMessageCallbackW(
    hWnd: pointer,  # HWND
    Msg: uint32,  # DWORD
    wParam: uint,  # WPARAM
    lParam: int,  # LPARAM
    lpResultCallBack: pointer,  # SENDASYNCPROC
    dwData: uint  # UINT_PTR
): int32 {.importc: "SendMessageCallbackW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int SendMessageCallbackW(
    void* hWnd,   // HWND
    uint Msg,   // DWORD
    size_t wParam,   // WPARAM
    ptrdiff_t lParam,   // LPARAM
    void* lpResultCallBack,   // SENDASYNCPROC
    size_t dwData   // UINT_PTR
);
ccall((:SendMessageCallbackW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Csize_t, Int, Ptr{Cvoid}, Csize_t),
      hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
# hWnd : HWND -> Ptr{Cvoid}
# Msg : DWORD -> UInt32
# wParam : WPARAM -> Csize_t
# lParam : LPARAM -> Int
# lpResultCallBack : SENDASYNCPROC -> Ptr{Cvoid}
# dwData : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SendMessageCallbackW(
    void* hWnd,
    uint32_t Msg,
    uintptr_t wParam,
    intptr_t lParam,
    void* lpResultCallBack,
    uintptr_t dwData);
]]
local user32 = ffi.load("user32")
-- user32.SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
-- hWnd : HWND
-- Msg : DWORD
-- wParam : WPARAM
-- lParam : LPARAM
-- lpResultCallBack : SENDASYNCPROC
-- dwData : UINT_PTR
-- 構造体/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 SendMessageCallbackW = lib.func('__stdcall', 'SendMessageCallbackW', 'int32_t', ['void *', 'uint32_t', 'uintptr_t', 'intptr_t', 'void *', 'uintptr_t']);
// SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
// hWnd : HWND -> 'void *'
// Msg : DWORD -> 'uint32_t'
// wParam : WPARAM -> 'uintptr_t'
// lParam : LPARAM -> 'intptr_t'
// lpResultCallBack : SENDASYNCPROC -> 'void *'
// dwData : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("USER32.dll", {
  SendMessageCallbackW: { parameters: ["pointer", "u32", "usize", "isize", "pointer", "usize"], result: "i32" },
});
// lib.symbols.SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData)
// hWnd : HWND -> "pointer"
// Msg : DWORD -> "u32"
// wParam : WPARAM -> "usize"
// lParam : LPARAM -> "isize"
// lpResultCallBack : SENDASYNCPROC -> "pointer"
// dwData : UINT_PTR -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SendMessageCallbackW(
    void* hWnd,
    uint32_t Msg,
    size_t wParam,
    intptr_t lParam,
    void* lpResultCallBack,
    size_t dwData);
C, "USER32.dll");
// $ffi->SendMessageCallbackW(hWnd, Msg, wParam, lParam, lpResultCallBack, dwData);
// hWnd : HWND
// Msg : DWORD
// wParam : WPARAM
// lParam : LPARAM
// lpResultCallBack : SENDASYNCPROC
// dwData : UINT_PTR
// 構造体/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);
    boolean SendMessageCallbackW(
        Pointer hWnd,   // HWND
        int Msg,   // DWORD
        long wParam,   // WPARAM
        long lParam,   // LPARAM
        Callback lpResultCallBack,   // SENDASYNCPROC
        long dwData   // UINT_PTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SendMessageCallbackW = SendMessageCallbackW(
    hWnd : Void*,   # HWND
    Msg : UInt32,   # DWORD
    wParam : LibC::SizeT,   # WPARAM
    lParam : LibC::SSizeT,   # LPARAM
    lpResultCallBack : Void*,   # SENDASYNCPROC
    dwData : LibC::SizeT   # UINT_PTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SendMessageCallbackWNative = Int32 Function(Pointer<Void>, Uint32, UintPtr, IntPtr, Pointer<Void>, UintPtr);
typedef SendMessageCallbackWDart = int Function(Pointer<Void>, int, int, int, Pointer<Void>, int);
final SendMessageCallbackW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SendMessageCallbackWNative, SendMessageCallbackWDart>('SendMessageCallbackW');
// hWnd : HWND -> Pointer<Void>
// Msg : DWORD -> Uint32
// wParam : WPARAM -> UintPtr
// lParam : LPARAM -> IntPtr
// lpResultCallBack : SENDASYNCPROC -> Pointer<Void>
// dwData : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SendMessageCallbackW(
  hWnd: THandle;   // HWND
  Msg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt;   // LPARAM
  lpResultCallBack: Pointer;   // SENDASYNCPROC
  dwData: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'USER32.dll' name 'SendMessageCallbackW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SendMessageCallbackW"
  c_SendMessageCallbackW :: Ptr () -> Word32 -> CUIntPtr -> CIntPtr -> Ptr () -> CUIntPtr -> IO CInt
-- hWnd : HWND -> Ptr ()
-- Msg : DWORD -> Word32
-- wParam : WPARAM -> CUIntPtr
-- lParam : LPARAM -> CIntPtr
-- lpResultCallBack : SENDASYNCPROC -> Ptr ()
-- dwData : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sendmessagecallbackw =
  foreign "SendMessageCallbackW"
    ((ptr void) @-> uint32_t @-> size_t @-> intptr_t @-> (ptr void) @-> size_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* Msg : DWORD -> uint32_t *)
(* wParam : WPARAM -> size_t *)
(* lParam : LPARAM -> intptr_t *)
(* lpResultCallBack : SENDASYNCPROC -> (ptr void) *)
(* dwData : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SendMessageCallbackW" send-message-callback-w :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (msg :uint32)   ; DWORD
  (w-param :uint64)   ; WPARAM
  (l-param :int64)   ; LPARAM
  (lp-result-call-back :pointer)   ; SENDASYNCPROC
  (dw-data :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SendMessageCallbackW = Win32::API::More->new('USER32',
    'BOOL SendMessageCallbackW(HANDLE hWnd, DWORD Msg, WPARAM wParam, LPARAM lParam, LPVOID lpResultCallBack, WPARAM dwData)');
# my $ret = $SendMessageCallbackW->Call($hWnd, $Msg, $wParam, $lParam, $lpResultCallBack, $dwData);
# hWnd : HWND -> HANDLE
# Msg : DWORD -> DWORD
# wParam : WPARAM -> WPARAM
# lParam : LPARAM -> LPARAM
# lpResultCallBack : SENDASYNCPROC -> LPVOID
# dwData : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型