ホーム › UI.WindowsAndMessaging › DispatchMessageA

DispatchMessageA

関数

メッセージを対応するウィンドウプロシージャへ送出する(ANSI)。

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

シグネチャ

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

LRESULT DispatchMessageA(
    const MSG* lpMsg
);

パラメーター

名前	型	方向	説明
lpMsg	MSG*	in	メッセージを格納する構造体へのポインターです。

戻り値の型: LRESULT

公式ドキュメント

メッセージをウィンドウプロシージャにディスパッチします。通常、GetMessage 関数で取得したメッセージをディスパッチするために使用します。(DispatchMessageA)

戻り値

型: LRESULT

戻り値には、ウィンドウプロシージャが返した値が格納されます。その意味はディスパッチされるメッセージによって異なりますが、一般的にこの戻り値は無視されます。

解説(Remarks)

MSG 構造体には有効なメッセージ値が含まれている必要があります。lpmsg パラメーターが WM_TIMER メッセージを指し、その WM_TIMER メッセージの lParam パラメーターが NULL でない場合、lParam はウィンドウプロシージャの代わりに呼び出される関数を指します。

入力メッセージの取得とダイアログボックスへのディスパッチは、アプリケーションが行う必要がある点に注意してください。ほとんどのアプリケーションはこの目的でメインメッセージループを使用します。ただし、ユーザーがキーボードを使ってコントロール間を移動したり選択したりできるようにするには、アプリケーションが IsDialogMessage を呼び出す必要があります。詳細については、「Dialog Box Keyboard Interface」を参照してください。

例

例については、「Creating a Message Loop」を参照してください。

メモ

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

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

[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr DispatchMessageA(
    IntPtr lpMsg   // MSG*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DispatchMessageA(
    lpMsg As IntPtr   ' MSG*
) As IntPtr
End Function

' lpMsg : MSG*
Declare PtrSafe Function DispatchMessageA Lib "user32" ( _
    ByVal lpMsg As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DispatchMessageA = ctypes.windll.user32.DispatchMessageA
DispatchMessageA.restype = ctypes.c_ssize_t
DispatchMessageA.argtypes = [
    ctypes.c_void_p,  # lpMsg : MSG*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DispatchMessageA = Fiddle::Function.new(
  lib['DispatchMessageA'],
  [
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "user32")]
extern "system" {
    fn DispatchMessageA(
        lpMsg: *const MSG  // MSG*
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr DispatchMessageA(IntPtr lpMsg);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DispatchMessageA' -Namespace Win32 -PassThru
# $api::DispatchMessageA(lpMsg)

#uselib "USER32.dll"
#func global DispatchMessageA "DispatchMessageA" sptr
; DispatchMessageA varptr(lpMsg)   ; 戻り値は stat
; lpMsg : MSG* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DispatchMessageA "DispatchMessageA" var
; res = DispatchMessageA(lpMsg)
; lpMsg : MSG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DispatchMessageA "DispatchMessageA" sptr
; res = DispatchMessageA(varptr(lpMsg))
; lpMsg : MSG* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。