ホーム › UI.WindowsAndMessaging › DispatchMessageW

DispatchMessageW

関数

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

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

シグネチャ

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

LRESULT DispatchMessageW(
    const MSG* lpMsg
);

パラメーター

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

戻り値の型: LRESULT

公式ドキュメント

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

戻り値

型: LRESULT

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

解説(Remarks)

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

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

例

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DispatchMessage を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「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>

LRESULT DispatchMessageW(
    const MSG* lpMsg
);

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

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

' lpMsg : MSG*
Declare PtrSafe Function DispatchMessageW Lib "user32" ( _
    ByVal lpMsg 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DispatchMessageW = Fiddle::Function.new(
  lib['DispatchMessageW'],
  [
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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