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

GetMessageW

関数
呼び出しスレッドのメッセージキューからメッセージを取得する。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetMessageW(
    MSG* lpMsg,
    HWND hWnd,   // optional
    DWORD wMsgFilterMin,
    DWORD wMsgFilterMax
);

パラメーター

名前方向説明
lpMsgMSG*outスレッドのメッセージキューからメッセージ情報を受け取る MSG 構造体へのポインターです。
hWndHWNDinoptional

メッセージを取得する対象のウィンドウへのハンドルです。ウィンドウは現在のスレッドに属している必要があります。

hWndNULL の場合、GetMessage は現在のスレッドに属する任意のウィンドウのメッセージと、現在のスレッドのメッセージキュー上で hwnd 値が NULL のメッセージ (MSG 構造体を参照) を取得します。したがって hWnd が NULL の場合は、ウィンドウメッセージとスレッドメッセージの両方が処理されます。

hWnd が -1 の場合、GetMessage は現在のスレッドのメッセージキュー上で hwnd 値が NULL のメッセージのみ、すなわち PostMessage (hWnd パラメーターが NULL の場合) または PostThreadMessage によってポストされたスレッドメッセージのみを取得します。

wMsgFilterMinDWORDin

取得するメッセージ値の最小値を表す整数値です。最初のキーボードメッセージを指定するには WM_KEYFIRST (0x0100) を、最初のマウスメッセージを指定するには WM_MOUSEFIRST (0x0200) を使用します。

WM_INPUT メッセージのみを指定するには、ここと wMsgFilterMaxWM_INPUT を使用します。

wMsgFilterMinwMsgFilterMax がともに 0 の場合、GetMessage は利用可能なすべてのメッセージを返します (つまり、範囲によるフィルタリングは行われません)。

wMsgFilterMaxDWORDin

取得するメッセージ値の最大値を表す整数値です。最後のキーボードメッセージを指定するには WM_KEYLAST を、最後のマウスメッセージを指定するには WM_MOUSELAST を使用します。

WM_INPUT メッセージのみを指定するには、ここと wMsgFilterMinWM_INPUT を使用します。

wMsgFilterMinwMsgFilterMax がともに 0 の場合、GetMessage は利用可能なすべてのメッセージを返します (つまり、範囲によるフィルタリングは行われません)。

戻り値の型: BOOL

公式ドキュメント

GetMessageW 関数 (Unicode) は、呼び出し元スレッドのメッセージキューからメッセージを取得します。(GetMessageW)

戻り値

型: BOOL

関数が WM_QUIT 以外のメッセージを取得した場合、戻り値は 0 以外になります。

関数が WM_QUIT メッセージを取得した場合、戻り値は 0 になります。

エラーが発生した場合、戻り値は -1 になります。たとえば、hWnd が無効なウィンドウハンドルである場合や、lpMsg が無効なポインターである場合に、この関数は失敗します。拡張エラー情報を取得するには、GetLastError を呼び出します。

戻り値は 0 以外、0、または -1 のいずれにもなり得るため、次のようなコードは避けてください。

while (GetMessage( lpMsg, hWnd, 0, 0)) ...

hWnd が無効なパラメーター (たとえば既に破棄されたウィンドウを参照している場合など) のときに -1 が返される可能性があるため、このようなコードは致命的なアプリケーションエラーを引き起こすおそれがあります。代わりに、次のようなコードを使用してください。

BOOL bRet;

while( (bRet = GetMessage( &msg, hWnd, 0, 0 )) != 0)
{ 
    if (bRet == -1)
    {
        // handle the error and possibly exit
    }
    else
    {
        TranslateMessage(&msg); 
        DispatchMessage(&msg); 
    }
}

解説(Remarks)

アプリケーションは通常、戻り値を使用してメインメッセージループを終了してプログラムを終了するかどうかを判断します。

GetMessage 関数は、hWnd パラメーターで指定されたウィンドウ、または IsChild 関数で指定されるその子ウィンドウに関連付けられたメッセージを、wMsgFilterMin および wMsgFilterMax パラメーターで指定された範囲内で取得します。wMsgFilterMin および wMsgFilterMax パラメーターでは下位ワードのみを使用できることに注意してください。上位ワードはシステム用に予約されています。

wMsgFilterMin および wMsgFilterMax にどのような値を指定しても、GetMessage は常に WM_QUIT メッセージを取得することに注意してください。

この呼び出しの間、システムは保留中の非キュー型メッセージ、すなわち SendMessageSendMessageCallbackSendMessageTimeout、または SendNotifyMessage 関数を使用して呼び出し元スレッドが所有するウィンドウに送信されたメッセージを配信します。その後、指定されたフィルターに一致する最初のキュー型メッセージが取得されます。システムは内部イベントも処理する場合があります。フィルターが指定されていない場合、メッセージは次の順序で処理されます。

ポストメッセージより先に入力メッセージを取得するには、wMsgFilterMin および wMsgFilterMax パラメーターを使用します。

GetMessageWM_PAINT メッセージをキューから削除しません。これらのメッセージは処理されるまでキューに残ります。

トップレベルウィンドウが数秒以上にわたってメッセージへの応答を停止すると、システムはそのウィンドウを応答していないと見なし、同じ z オーダー、位置、サイズ、視覚的属性を持つゴーストウィンドウに置き換えます。これにより、ユーザーはウィンドウを移動、サイズ変更、あるいはアプリケーションを終了できます。ただし、アプリケーションは実際には応答していないため、利用できる操作はこれらに限られます。デバッガーモードの場合、システムはゴーストウィンドウを生成しません。

DPI 仮想化

この API は DPI 仮想化に参加しません。出力は、メッセージの対象となるウィンドウのモードになります。呼び出し元スレッドは考慮されません。

例については、メッセージループの作成を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetMessageW(
    MSG* lpMsg,
    HWND hWnd,   // optional
    DWORD wMsgFilterMin,
    DWORD wMsgFilterMax
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetMessageW(
    IntPtr lpMsg,   // MSG* out
    IntPtr hWnd,   // HWND optional
    uint wMsgFilterMin,   // DWORD
    uint wMsgFilterMax   // DWORD
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMessageW(
    lpMsg As IntPtr,   ' MSG* out
    hWnd As IntPtr,   ' HWND optional
    wMsgFilterMin As UInteger,   ' DWORD
    wMsgFilterMax As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpMsg : MSG* out
' hWnd : HWND optional
' wMsgFilterMin : DWORD
' wMsgFilterMax : DWORD
Declare PtrSafe Function GetMessageW Lib "user32" ( _
    ByVal lpMsg As LongPtr, _
    ByVal hWnd As LongPtr, _
    ByVal wMsgFilterMin As Long, _
    ByVal wMsgFilterMax As Long) 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

GetMessageW = ctypes.windll.user32.GetMessageW
GetMessageW.restype = wintypes.BOOL
GetMessageW.argtypes = [
    ctypes.c_void_p,  # lpMsg : MSG* out
    wintypes.HANDLE,  # hWnd : HWND optional
    wintypes.DWORD,  # wMsgFilterMin : DWORD
    wintypes.DWORD,  # wMsgFilterMax : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMessageW = Fiddle::Function.new(
  lib['GetMessageW'],
  [
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG* out
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    -Fiddle::TYPE_INT,  # wMsgFilterMin : DWORD
    -Fiddle::TYPE_INT,  # wMsgFilterMax : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn GetMessageW(
        lpMsg: *mut MSG,  // MSG* out
        hWnd: *mut core::ffi::c_void,  // HWND optional
        wMsgFilterMin: u32,  // DWORD
        wMsgFilterMax: u32  // DWORD
    ) -> 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 GetMessageW(IntPtr lpMsg, IntPtr hWnd, uint wMsgFilterMin, uint wMsgFilterMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMessageW' -Namespace Win32 -PassThru
# $api::GetMessageW(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax)
#uselib "USER32.dll"
#func global GetMessageW "GetMessageW" wptr, wptr, wptr, wptr
; GetMessageW varptr(lpMsg), hWnd, wMsgFilterMin, wMsgFilterMax   ; 戻り値は stat
; lpMsg : MSG* out -> "wptr"
; hWnd : HWND optional -> "wptr"
; wMsgFilterMin : DWORD -> "wptr"
; wMsgFilterMax : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetMessageW "GetMessageW" var, sptr, int, int
; res = GetMessageW(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax)
; lpMsg : MSG* out -> "var"
; hWnd : HWND optional -> "sptr"
; wMsgFilterMin : DWORD -> "int"
; wMsgFilterMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetMessageW(MSG* lpMsg, HWND hWnd, DWORD wMsgFilterMin, DWORD wMsgFilterMax)
#uselib "USER32.dll"
#cfunc global GetMessageW "GetMessageW" var, intptr, int, int
; res = GetMessageW(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax)
; lpMsg : MSG* out -> "var"
; hWnd : HWND optional -> "intptr"
; wMsgFilterMin : DWORD -> "int"
; wMsgFilterMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetMessageW = user32.NewProc("GetMessageW")
)

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

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

typedef GetMessageWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32);
typedef GetMessageWDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final GetMessageW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetMessageWNative, GetMessageWDart>('GetMessageW');
// lpMsg : MSG* out -> Pointer<Void>
// hWnd : HWND optional -> Pointer<Void>
// wMsgFilterMin : DWORD -> Uint32
// wMsgFilterMax : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetMessageW(
  lpMsg: Pointer;   // MSG* out
  hWnd: THandle;   // HWND optional
  wMsgFilterMin: DWORD;   // DWORD
  wMsgFilterMax: DWORD   // DWORD
): BOOL; stdcall;
  external 'USER32.dll' name 'GetMessageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetMessageW"
  c_GetMessageW :: Ptr () -> Ptr () -> Word32 -> Word32 -> IO CInt
-- lpMsg : MSG* out -> Ptr ()
-- hWnd : HWND optional -> Ptr ()
-- wMsgFilterMin : DWORD -> Word32
-- wMsgFilterMax : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmessagew =
  foreign "GetMessageW"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpMsg : MSG* out -> (ptr void) *)
(* hWnd : HWND optional -> (ptr void) *)
(* wMsgFilterMin : DWORD -> uint32_t *)
(* wMsgFilterMax : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetMessageW" get-message-w :convention :stdcall) :int32
  (lp-msg :pointer)   ; MSG* out
  (h-wnd :pointer)   ; HWND optional
  (w-msg-filter-min :uint32)   ; DWORD
  (w-msg-filter-max :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetMessageW = Win32::API::More->new('USER32',
    'BOOL GetMessageW(LPVOID lpMsg, HANDLE hWnd, DWORD wMsgFilterMin, DWORD wMsgFilterMax)');
# my $ret = $GetMessageW->Call($lpMsg, $hWnd, $wMsgFilterMin, $wMsgFilterMax);
# lpMsg : MSG* out -> LPVOID
# hWnd : HWND optional -> HANDLE
# wMsgFilterMin : DWORD -> DWORD
# wMsgFilterMax : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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