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

PeekMessageW

関数
キューを調べメッセージを取得する(Unicode、非ブロッキング)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PeekMessageW(
    MSG* lpMsg,
    HWND hWnd,   // optional
    DWORD wMsgFilterMin,
    DWORD wMsgFilterMax,
    PEEK_MESSAGE_REMOVE_TYPE wRemoveMsg
);

パラメーター

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

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

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

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

wMsgFilterMinDWORDin

調べるメッセージの範囲のうち、最初のメッセージの値です。最初のキーボードメッセージを指定するには WM_KEYFIRST (0x0100) を、最初のマウスメッセージを指定するには WM_MOUSEFIRST (0x0200) を使用します。

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

wMsgFilterMaxDWORDin

調べるメッセージの範囲のうち、最後のメッセージの値です。最後のキーボードメッセージを指定するには WM_KEYLAST を、最後のマウスメッセージを指定するには WM_MOUSELAST を使用します。

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

wRemoveMsgPEEK_MESSAGE_REMOVE_TYPEin

メッセージの処理方法を指定します。このパラメーターには、次の値を 1 つ以上指定できます。

意味
PM_NOREMOVE
0x0000
PeekMessage による処理後も、メッセージはキューから削除されません。
PM_REMOVE
0x0001
PeekMessage による処理後に、メッセージはキューから削除されます。
PM_NOYIELD
0x0002
呼び出し元がアイドル状態になるのを待機しているスレッドを、システムが解放しないようにします (WaitForInputIdle を参照)。この値は PM_NOREMOVE または PM_REMOVE のいずれかと組み合わせて使用します。

既定では、すべての種類のメッセージが処理されます。特定の種類のメッセージのみを処理するように指定するには、次の値を 1 つ以上指定します。

意味
PM_QS_INPUT
(QS_INPUT << 16)
マウスメッセージとキーボードメッセージを処理します。
PM_QS_POSTMESSAGE
((QS_POSTMESSAGE | QS_HOTKEY | QS_TIMER) << 16)
タイマーやホットキーを含む、すべてのポストされたメッセージを処理します。
PM_QS_PAINT
(QS_PAINT << 16)
描画 (paint) メッセージを処理します。
PM_QS_SENDMESSAGE
(QS_SENDMESSAGE << 16)
送信されたすべてのメッセージを処理します。

ここに示した QS_ フラグとメッセージの種類の詳細については、GetQueueStatus のドキュメントを参照してください。

戻り値の型: BOOL

公式ドキュメント

キューに入れられていない受信メッセージをディスパッチし、スレッドのメッセージキューにポストされたメッセージがないか調べ、(存在する場合は) メッセージを取得します。(Unicode)

戻り値

型: BOOL

メッセージが利用可能な場合、戻り値は 0 以外になります。

利用可能なメッセージがない場合、戻り値は 0 になります。

解説(Remarks)

PeekMessage は、hWnd パラメーターで指定されたウィンドウ、または IsChild 関数で示されるその子ウィンドウに関連付けられたメッセージのうち、wMsgFilterMin および wMsgFilterMax パラメーターで指定された値の範囲内にあるものを取得します。なお、アプリケーションが使用できるのは wMsgFilterMin および wMsgFilterMax パラメーターの下位ワードのみであり、上位ワードはシステム用に予約されています。

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

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

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

PeekMessage 関数は、通常は WM_PAINT メッセージをキューから削除しません。WM_PAINT メッセージは、処理されるまでキューに残ります。ただし、WM_PAINT メッセージの更新領域が NULL の場合、PeekMessage はそれをキューから削除します。

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

DPI 仮想化

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

例については、メッセージキューの調査を参照してください。

メモ

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

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

PeekMessageW = ctypes.windll.user32.PeekMessageW
PeekMessageW.restype = wintypes.BOOL
PeekMessageW.argtypes = [
    ctypes.c_void_p,  # lpMsg : MSG* out
    wintypes.HANDLE,  # hWnd : HWND optional
    wintypes.DWORD,  # wMsgFilterMin : DWORD
    wintypes.DWORD,  # wMsgFilterMax : DWORD
    wintypes.DWORD,  # wRemoveMsg : PEEK_MESSAGE_REMOVE_TYPE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procPeekMessageW = user32.NewProc("PeekMessageW")
)

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

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

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

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

let peekmessagew =
  foreign "PeekMessageW"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> 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 *)
(* wRemoveMsg : PEEK_MESSAGE_REMOVE_TYPE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("PeekMessageW" peek-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
  (w-remove-msg :uint32))   ; PEEK_MESSAGE_REMOVE_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PeekMessageW = Win32::API::More->new('USER32',
    'BOOL PeekMessageW(LPVOID lpMsg, HANDLE hWnd, DWORD wMsgFilterMin, DWORD wMsgFilterMax, DWORD wRemoveMsg)');
# my $ret = $PeekMessageW->Call($lpMsg, $hWnd, $wMsgFilterMin, $wMsgFilterMax, $wRemoveMsg);
# lpMsg : MSG* out -> LPVOID
# hWnd : HWND optional -> HANDLE
# wMsgFilterMin : DWORD -> DWORD
# wMsgFilterMax : DWORD -> DWORD
# wRemoveMsg : PEEK_MESSAGE_REMOVE_TYPE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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