ホーム › UI.WindowsAndMessaging › SendMessageTimeoutA

SendMessageTimeoutA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

LRESULT SendMessageTimeoutA(
    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 つ以上のウィンドウに送信します。(ANSI)

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

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

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SendMessageTimeoutA(
    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.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SendMessageTimeoutA(
    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 SendMessageTimeoutA 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
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SendMessageTimeoutA = ctypes.windll.user32.SendMessageTimeoutA
SendMessageTimeoutA.restype = ctypes.c_ssize_t
SendMessageTimeoutA.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')
SendMessageTimeoutA = Fiddle::Function.new(
  lib['SendMessageTimeoutA'],
  [
    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)

#[link(name = "user32")]
extern "system" {
    fn SendMessageTimeoutA(
        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.Ansi, SetLastError = true)]
public static extern IntPtr SendMessageTimeoutA(IntPtr hWnd, uint Msg, UIntPtr wParam, IntPtr lParam, uint fuFlags, uint uTimeout, IntPtr lpdwResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SendMessageTimeoutA' -Namespace Win32 -PassThru
# $api::SendMessageTimeoutA(hWnd, Msg, wParam, lParam, fuFlags, uTimeout, lpdwResult)

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

出力引数:

#uselib "USER32.dll"
#cfunc global SendMessageTimeoutA "SendMessageTimeoutA" sptr, int, sptr, sptr, int, int, var
; res = SendMessageTimeoutA(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 SendMessageTimeoutA "SendMessageTimeoutA" sptr, int, sptr, sptr, int, int, sptr
; res = SendMessageTimeoutA(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(変数))。