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

PeekMessageA

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

シグネチャ

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

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

パラメーター

名前方向
lpMsgMSG*out
hWndHWNDinoptional
wMsgFilterMinDWORDin
wMsgFilterMaxDWORDin
wRemoveMsgPEEK_MESSAGE_REMOVE_TYPEin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL PeekMessageA(
    MSG* lpMsg,
    HWND hWnd,   // optional
    DWORD wMsgFilterMin,
    DWORD wMsgFilterMax,
    PEEK_MESSAGE_REMOVE_TYPE wRemoveMsg
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PeekMessageA(
    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.Ansi, ExactSpelling:=True)>
Public Shared Function PeekMessageA(
    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 Boolean
End Function
' lpMsg : MSG* out
' hWnd : HWND optional
' wMsgFilterMin : DWORD
' wMsgFilterMax : DWORD
' wRemoveMsg : PEEK_MESSAGE_REMOVE_TYPE
Declare PtrSafe Function PeekMessageA Lib "user32" ( _
    ByVal lpMsg As LongPtr, _
    ByVal hWnd As LongPtr, _
    ByVal wMsgFilterMin As Long, _
    ByVal wMsgFilterMax As Long, _
    ByVal wRemoveMsg As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PeekMessageA = ctypes.windll.user32.PeekMessageA
PeekMessageA.restype = wintypes.BOOL
PeekMessageA.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')
PeekMessageA = Fiddle::Function.new(
  lib['PeekMessageA'],
  [
    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)
#[link(name = "user32")]
extern "system" {
    fn PeekMessageA(
        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.Ansi)]
public static extern bool PeekMessageA(IntPtr lpMsg, IntPtr hWnd, uint wMsgFilterMin, uint wMsgFilterMax, uint wRemoveMsg);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_PeekMessageA' -Namespace Win32 -PassThru
# $api::PeekMessageA(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax, wRemoveMsg)
#uselib "USER32.dll"
#func global PeekMessageA "PeekMessageA" sptr, sptr, sptr, sptr, sptr
; PeekMessageA varptr(lpMsg), hWnd, wMsgFilterMin, wMsgFilterMax, wRemoveMsg   ; 戻り値は stat
; lpMsg : MSG* out -> "sptr"
; hWnd : HWND optional -> "sptr"
; wMsgFilterMin : DWORD -> "sptr"
; wMsgFilterMax : DWORD -> "sptr"
; wRemoveMsg : PEEK_MESSAGE_REMOVE_TYPE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global PeekMessageA "PeekMessageA" var, sptr, int, int, int
; res = PeekMessageA(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 PeekMessageA(MSG* lpMsg, HWND hWnd, DWORD wMsgFilterMin, DWORD wMsgFilterMax, PEEK_MESSAGE_REMOVE_TYPE wRemoveMsg)
#uselib "USER32.dll"
#cfunc global PeekMessageA "PeekMessageA" var, intptr, int, int, int
; res = PeekMessageA(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")
	procPeekMessageA = user32.NewProc("PeekMessageA")
)

// lpMsg (MSG* out), hWnd (HWND optional), wMsgFilterMin (DWORD), wMsgFilterMax (DWORD), wRemoveMsg (PEEK_MESSAGE_REMOVE_TYPE)
r1, _, err := procPeekMessageA.Call(
	uintptr(lpMsg),
	uintptr(hWnd),
	uintptr(wMsgFilterMin),
	uintptr(wMsgFilterMax),
	uintptr(wRemoveMsg),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PeekMessageA(
  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 'PeekMessageA';
result := DllCall("USER32\PeekMessageA"
    , "Ptr", lpMsg   ; MSG* out
    , "Ptr", hWnd   ; HWND optional
    , "UInt", wMsgFilterMin   ; DWORD
    , "UInt", wMsgFilterMax   ; DWORD
    , "UInt", wRemoveMsg   ; PEEK_MESSAGE_REMOVE_TYPE
    , "Int")   ; return: BOOL
●PeekMessageA(lpMsg, hWnd, wMsgFilterMin, wMsgFilterMax, wRemoveMsg) = DLL("USER32.dll", "bool PeekMessageA(void*, void*, dword, dword, dword)")
# 呼び出し: PeekMessageA(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)。