ホーム › UI.WindowsAndMessaging › GetMessageA

GetMessageA

関数

メッセージキューからメッセージを取得する(ANSI)。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
lpMsg	MSG*	out	スレッドのメッセージキューからメッセージ情報を受け取る MSG 構造体へのポインターです。
hWnd	HWND	inoptional	メッセージを取得する対象のウィンドウへのハンドルです。このウィンドウは現在のスレッドに属している必要があります。 hWnd が NULL の場合、GetMessage は現在のスレッドに属する任意のウィンドウのメッセージと、hwnd の値が NULL である現在のスレッドのメッセージキュー上のメッセージ（MSG 構造体を参照）を取得します。したがって hWnd が NULL の場合、ウィンドウメッセージとスレッドメッセージの両方が処理されます。 hWnd が -1 の場合、GetMessage は現在のスレッドのメッセージキュー上で hwnd の値が NULL であるメッセージのみ、すなわち PostMessage（hWnd パラメーターが NULL の場合）または PostThreadMessage によってポストされたスレッドメッセージのみを取得します。
wMsgFilterMin	DWORD	in	取得する最小のメッセージ値を表す整数値です。最初のキーボードメッセージを指定するには WM_KEYFIRST (0x0100) を、最初のマウスメッセージを指定するには WM_MOUSEFIRST (0x0200) を使用します。 WM_INPUT メッセージのみを指定するには、ここと wMsgFilterMax に WM_INPUT を使用します。 wMsgFilterMin と wMsgFilterMax がいずれもゼロの場合、GetMessage は利用可能なすべてのメッセージを返します（つまり範囲フィルタリングは行われません）。
wMsgFilterMax	DWORD	in	取得する最大のメッセージ値を表す整数値です。最後のキーボードメッセージを指定するには WM_KEYLAST を、最後のマウスメッセージを指定するには WM_MOUSELAST を使用します。 WM_INPUT メッセージのみを指定するには、ここと wMsgFilterMin に WM_INPUT を使用します。 wMsgFilterMin と wMsgFilterMax がいずれもゼロの場合、GetMessage は利用可能なすべてのメッセージを返します（つまり範囲フィルタリングは行われません）。

戻り値の型: BOOL

公式ドキュメント

呼び出し元スレッドのメッセージキューからメッセージを取得します。この関数は、取得可能なポストされたメッセージが用意されるまで、送られてきた送信メッセージをディスパッチします。(GetMessageA)

戻り値

型: 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 パラメーターの下位ワードのみを使用できます。上位ワードはシステム用に予約されています。

なお、GetMessage は wMsgFilterMin および wMsgFilterMax にどのような値を指定しても、常に WM_QUIT メッセージを取得します。

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

送信メッセージ
ポストされたメッセージ
入力（ハードウェア）メッセージおよびシステム内部イベント
送信メッセージ（再度）
WM_PAINT メッセージ
WM_TIMER メッセージ

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

GetMessage は WM_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  (ANSI / -A)
#include <windows.h>

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetMessageA(
    IntPtr lpMsg,   // MSG* out
    IntPtr hWnd,   // HWND optional
    uint wMsgFilterMin,   // DWORD
    uint wMsgFilterMax   // DWORD
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMessageA(
    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 GetMessageA Lib "user32" ( _
    ByVal lpMsg As LongPtr, _
    ByVal hWnd As LongPtr, _
    ByVal wMsgFilterMin As Long, _
    ByVal wMsgFilterMax As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

#[link(name = "user32")]
extern "system" {
    fn GetMessageA(
        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.Ansi, SetLastError = true)]
public static extern bool GetMessageA(IntPtr lpMsg, IntPtr hWnd, uint wMsgFilterMin, uint wMsgFilterMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMessageA' -Namespace Win32 -PassThru
# $api::GetMessageA(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax)

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

出力引数:

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