ホーム › UI.WindowsAndMessaging › SendMessageTimeoutW

SendMessageTimeoutW

関数

タイムアウト付きでメッセージを送る(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

LRESULT SendMessageTimeoutW(
    HWND hWnd,
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam,
    SEND_MESSAGE_TIMEOUT_FLAGS fuFlags,
    DWORD uTimeout,
    UINT_PTR* lpdwResult   // optional
);

パラメーター

名前

型

方向

説明

hWnd

HWND

メッセージを受け取るウィンドウプロシージャを持つウィンドウへのハンドル。

このパラメーターが HWND_BROADCAST ((HWND)0xffff) の場合、メッセージはシステム内のすべてのトップレベルウィンドウ(無効化された、または非表示の所有者なしウィンドウを含む)へ送信されます。この関数は各ウィンドウがタイムアウトするまで戻りません。したがって、合計の待機時間は最大で uTimeout の値にトップレベルウィンドウの数を掛けた値になることがあります。

Msg

DWORD

送信するメッセージ。

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

wParam

WPARAM

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

lParam

LPARAM

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

fuFlags

SEND_MESSAGE_TIMEOUT_FLAGS

この関数の動作。このパラメーターには次の値を 1 つ以上指定できます。

値	意味
SMTO_ABORTIFHUNG 0x0002	受信側スレッドが応答していない、または「ハング」しているように見える場合、関数はタイムアウト期間の経過を待たずに戻ります。
SMTO_BLOCK 0x0001	関数が戻るまで、呼び出し元スレッドが他の要求を処理することを防ぎます。
SMTO_NORMAL 0x0000	関数が戻るのを待っている間、呼び出し元スレッドが他の要求を処理することは妨げられません。
SMTO_NOTIMEOUTIFNOTHUNG 0x0008	受信側スレッドがメッセージを処理している間は、関数はタイムアウト期間を適用しません。
SMTO_ERRORONEXIT 0x0020	メッセージの処理中に受信側ウィンドウが破棄されたり、その所有スレッドが終了したりした場合、関数は 0 を返します。

uTimeout

DWORD

タイムアウト期間の長さ(ミリ秒単位)。メッセージがブロードキャストメッセージの場合、各ウィンドウはタイムアウト期間をフルに使用できます。たとえば、5 秒のタイムアウト期間を指定し、メッセージの処理に失敗するトップレベルウィンドウが 3 つある場合、最大で 15 秒の遅延が発生する可能性があります。

lpdwResult

UINT_PTR*

outoptional

メッセージ処理の結果。このパラメーターの値は、指定したメッセージによって異なります。

戻り値の型: LRESULT

公式ドキュメント

指定したメッセージを 1 つ以上のウィンドウへ送信します。(Unicode)

戻り値

型: LRESULT

関数が成功した場合、戻り値は 0 以外です。HWND_BROADCAST を使用した場合、SendMessageTimeout は個々のウィンドウのタイムアウトに関する情報を提供しません。

関数が失敗またはタイムアウトした場合、戻り値は 0 です。関数は失敗時に必ずしも SetLastError を呼び出すとは限らない点に注意してください。失敗の理由が重要な場合は、SendMessageTimeout を呼び出す前に SetLastError(ERROR_SUCCESS) を呼び出してください。関数が 0 を返し、GetLastError が ERROR_SUCCESS を返す場合は、一般的な失敗として扱ってください。

解説(Remarks)

この関数は指定したウィンドウのウィンドウプロシージャを呼び出します。指定したウィンドウが別のスレッドに属している場合、ウィンドウプロシージャがメッセージを処理し終えるか、指定したタイムアウト期間が経過するまで戻りません。メッセージを受け取るウィンドウが現在のスレッドと同じキューに属している場合、ウィンドウプロシージャは直接呼び出され、タイムアウト値は無視されます。

この関数は、スレッドが 5 秒以内に GetMessage または類似の関数を呼び出していない場合、そのスレッドが応答していないと見なします。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

LRESULT SendMessageTimeoutW(
    HWND hWnd,
    DWORD Msg,
    WPARAM wParam,
    LPARAM lParam,
    SEND_MESSAGE_TIMEOUT_FLAGS fuFlags,
    DWORD uTimeout,
    UINT_PTR* lpdwResult   // optional
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SendMessageTimeoutW(
    IntPtr hWnd,   // HWND
    uint Msg,   // DWORD
    UIntPtr wParam,   // WPARAM
    IntPtr lParam,   // LPARAM
    uint fuFlags,   // SEND_MESSAGE_TIMEOUT_FLAGS
    uint uTimeout,   // DWORD
    IntPtr lpdwResult   // UINT_PTR* optional, out
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SendMessageTimeoutW(
    hWnd As IntPtr,   ' HWND
    Msg As UInteger,   ' DWORD
    wParam As UIntPtr,   ' WPARAM
    lParam As IntPtr,   ' LPARAM
    fuFlags As UInteger,   ' SEND_MESSAGE_TIMEOUT_FLAGS
    uTimeout As UInteger,   ' DWORD
    lpdwResult As IntPtr   ' UINT_PTR* optional, out
) As IntPtr
End Function

' hWnd : HWND
' Msg : DWORD
' wParam : WPARAM
' lParam : LPARAM
' fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS
' uTimeout : DWORD
' lpdwResult : UINT_PTR* optional, out
Declare PtrSafe Function SendMessageTimeoutW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal Msg As Long, _
    ByVal wParam As LongPtr, _
    ByVal lParam As LongPtr, _
    ByVal fuFlags As Long, _
    ByVal uTimeout As Long, _
    ByVal lpdwResult 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

SendMessageTimeoutW = ctypes.windll.user32.SendMessageTimeoutW
SendMessageTimeoutW.restype = ctypes.c_ssize_t
SendMessageTimeoutW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.DWORD,  # Msg : DWORD
    ctypes.c_size_t,  # wParam : WPARAM
    ctypes.c_ssize_t,  # lParam : LPARAM
    wintypes.DWORD,  # fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS
    wintypes.DWORD,  # uTimeout : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # lpdwResult : UINT_PTR* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SendMessageTimeoutW = Fiddle::Function.new(
  lib['SendMessageTimeoutW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    -Fiddle::TYPE_INT,  # Msg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # wParam : WPARAM
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    -Fiddle::TYPE_INT,  # fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS
    -Fiddle::TYPE_INT,  # uTimeout : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwResult : UINT_PTR* optional, out
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn SendMessageTimeoutW(
        hWnd: *mut core::ffi::c_void,  // HWND
        Msg: u32,  // DWORD
        wParam: usize,  // WPARAM
        lParam: isize,  // LPARAM
        fuFlags: u32,  // SEND_MESSAGE_TIMEOUT_FLAGS
        uTimeout: u32,  // DWORD
        lpdwResult: *mut usize  // UINT_PTR* optional, out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr SendMessageTimeoutW(IntPtr hWnd, uint Msg, UIntPtr wParam, IntPtr lParam, uint fuFlags, uint uTimeout, IntPtr lpdwResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SendMessageTimeoutW' -Namespace Win32 -PassThru
# $api::SendMessageTimeoutW(hWnd, Msg, wParam, lParam, fuFlags, uTimeout, lpdwResult)

#uselib "USER32.dll"
#func global SendMessageTimeoutW "SendMessageTimeoutW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SendMessageTimeoutW hWnd, Msg, wParam, lParam, fuFlags, uTimeout, varptr(lpdwResult)   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; Msg : DWORD -> "wptr"
; wParam : WPARAM -> "wptr"
; lParam : LPARAM -> "wptr"
; fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS -> "wptr"
; uTimeout : DWORD -> "wptr"
; lpdwResult : UINT_PTR* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global SendMessageTimeoutW "SendMessageTimeoutW" sptr, int, sptr, sptr, int, int, var
; res = SendMessageTimeoutW(hWnd, Msg, wParam, lParam, fuFlags, uTimeout, lpdwResult)
; hWnd : HWND -> "sptr"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS -> "int"
; uTimeout : DWORD -> "int"
; lpdwResult : UINT_PTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global SendMessageTimeoutW "SendMessageTimeoutW" sptr, int, sptr, sptr, int, int, sptr
; res = SendMessageTimeoutW(hWnd, Msg, wParam, lParam, fuFlags, uTimeout, varptr(lpdwResult))
; hWnd : HWND -> "sptr"
; Msg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; fuFlags : SEND_MESSAGE_TIMEOUT_FLAGS -> "int"
; uTimeout : DWORD -> "int"
; lpdwResult : UINT_PTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。