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

GetQueueStatus

関数
メッセージキューにあるメッセージの種類を取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

DWORD GetQueueStatus(
    QUEUE_STATUS_FLAGS flags
);

パラメーター

名前方向説明
flagsQUEUE_STATUS_FLAGSin

確認するメッセージの種類です。このパラメーターには、次の値のうち 1 つ以上を指定できます。

意味
QS_KEY
0x0001
WM_KEYUPWM_KEYDOWNWM_SYSKEYUP、または WM_SYSKEYDOWN メッセージがキューにあります。
QS_MOUSEMOVE
0x0002
WM_MOUSEMOVE メッセージがキューにあります。
QS_MOUSEBUTTON
0x0004
マウスボタンメッセージ(WM_LBUTTONUPWM_RBUTTONDOWN など)。
QS_POSTMESSAGE
0x0008
ポストされたメッセージ(ここに列挙されているもの以外)がキューにあります。詳細については、PostMessage を参照してください。
この値は、メッセージをフィルタリングしているかどうかにかかわらず、GetMessage または PeekMessage を呼び出すとクリアされます。
QS_TIMER
0x0010
WM_TIMER メッセージがキューにあります。
QS_PAINT
0x0020
WM_PAINT メッセージがキューにあります。
QS_SENDMESSAGE
0x0040
別のスレッドまたはアプリケーションによって送信されたメッセージがキューにあります。詳細については、SendMessage を参照してください。
QS_HOTKEY
0x0080
WM_HOTKEY メッセージがキューにあります。
QS_ALLPOSTMESSAGE
0x0100
ポストされたメッセージ(ここに列挙されているもの以外)がキューにあります。詳細については、PostMessage を参照してください。
この値は、メッセージをフィルタリングせずに GetMessage または PeekMessage を呼び出すとクリアされます。
QS_RAWINPUT
0x0400
Windows XP 以降: Raw Input メッセージがキューにあります。詳細については、Raw Input を参照してください。
QS_TOUCH
0x0800
Windows 8 以降: タッチ入力メッセージがキューにあります。詳細については、Touch Input を参照してください。
QS_POINTER
0x1000
Windows 8 以降: ポインター入力メッセージがキューにあります。詳細については、Pointer Input を参照してください。
QS_MOUSE
(QS_MOUSEMOVE | QS_MOUSEBUTTON)
WM_MOUSEMOVE メッセージまたはマウスボタンメッセージ(WM_LBUTTONUPWM_RBUTTONDOWN など)。
QS_INPUT
(QS_MOUSE | QS_KEY | QS_RAWINPUT | QS_TOUCH | QS_POINTER)
入力メッセージがキューにあります。
QS_ALLEVENTS
(QS_INPUT | QS_POSTMESSAGE | QS_TIMER | QS_PAINT | QS_HOTKEY)
入力メッセージ、WM_TIMERWM_PAINTWM_HOTKEY、またはポストされたメッセージがキューにあります。
QS_ALLINPUT
(QS_INPUT | QS_POSTMESSAGE | QS_TIMER | QS_PAINT | QS_HOTKEY | QS_SENDMESSAGE)
任意のメッセージがキューにあります。

戻り値の型: DWORD

公式ドキュメント

呼び出し元スレッドのメッセージキューに存在するメッセージの種類を取得します。

戻り値

型: DWORD

戻り値の上位ワードは、現在キューにあるメッセージの種類を示します。下位ワードは、前回の GetQueueStatusGetMessage、または PeekMessage 関数の呼び出し以降にキューに追加され、現在もキューに残っているメッセージの種類を示します。

解説(Remarks)

戻り値に QS_ フラグが存在しても、後続の GetMessage または PeekMessage 関数の呼び出しがメッセージを返すことを保証するものではありません。GetMessage および PeekMessage は内部的なフィルタリングを行うため、メッセージが内部で処理される場合があります。このため、GetQueueStatus の戻り値は、GetMessage または PeekMessage を呼び出すべきかどうかの手がかりとしてのみ考慮すべきです。

QS_ALLPOSTMESSAGE フラグと QS_POSTMESSAGE フラグは、クリアされるタイミングが異なります。QS_POSTMESSAGE は、メッセージをフィルタリングしているかどうかにかかわらず、GetMessage または PeekMessage を呼び出すとクリアされます。QS_ALLPOSTMESSAGE は、メッセージをフィルタリングせずに(wMsgFilterMinwMsgFilterMax が 0)GetMessage または PeekMessage を呼び出すとクリアされます。これは、異なる範囲のメッセージを取得するために PeekMessage を複数回呼び出す場合に役立ちます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

DWORD GetQueueStatus(
    QUEUE_STATUS_FLAGS flags
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint GetQueueStatus(
    uint flags   // QUEUE_STATUS_FLAGS
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetQueueStatus(
    flags As UInteger   ' QUEUE_STATUS_FLAGS
) As UInteger
End Function
' flags : QUEUE_STATUS_FLAGS
Declare PtrSafe Function GetQueueStatus Lib "user32" ( _
    ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetQueueStatus = ctypes.windll.user32.GetQueueStatus
GetQueueStatus.restype = wintypes.DWORD
GetQueueStatus.argtypes = [
    wintypes.DWORD,  # flags : QUEUE_STATUS_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetQueueStatus = Fiddle::Function.new(
  lib['GetQueueStatus'],
  [
    -Fiddle::TYPE_INT,  # flags : QUEUE_STATUS_FLAGS
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetQueueStatus(
        flags: u32  // QUEUE_STATUS_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern uint GetQueueStatus(uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetQueueStatus' -Namespace Win32 -PassThru
# $api::GetQueueStatus(flags)
#uselib "USER32.dll"
#func global GetQueueStatus "GetQueueStatus" sptr
; GetQueueStatus flags   ; 戻り値は stat
; flags : QUEUE_STATUS_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetQueueStatus "GetQueueStatus" int
; res = GetQueueStatus(flags)
; flags : QUEUE_STATUS_FLAGS -> "int"
; DWORD GetQueueStatus(QUEUE_STATUS_FLAGS flags)
#uselib "USER32.dll"
#cfunc global GetQueueStatus "GetQueueStatus" int
; res = GetQueueStatus(flags)
; flags : QUEUE_STATUS_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetQueueStatus = user32.NewProc("GetQueueStatus")
)

// flags (QUEUE_STATUS_FLAGS)
r1, _, err := procGetQueueStatus.Call(
	uintptr(flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetQueueStatus(
  flags: DWORD   // QUEUE_STATUS_FLAGS
): DWORD; stdcall;
  external 'USER32.dll' name 'GetQueueStatus';
result := DllCall("USER32\GetQueueStatus"
    , "UInt", flags   ; QUEUE_STATUS_FLAGS
    , "UInt")   ; return: DWORD
●GetQueueStatus(flags) = DLL("USER32.dll", "dword GetQueueStatus(dword)")
# 呼び出し: GetQueueStatus(flags)
# flags : QUEUE_STATUS_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetQueueStatus(
    flags: u32 // QUEUE_STATUS_FLAGS
) callconv(std.os.windows.WINAPI) u32;
proc GetQueueStatus(
    flags: uint32  # QUEUE_STATUS_FLAGS
): uint32 {.importc: "GetQueueStatus", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint GetQueueStatus(
    uint flags   // QUEUE_STATUS_FLAGS
);
ccall((:GetQueueStatus, "USER32.dll"), stdcall, UInt32,
      (UInt32,),
      flags)
# flags : QUEUE_STATUS_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetQueueStatus(
    uint32_t flags);
]]
local user32 = ffi.load("user32")
-- user32.GetQueueStatus(flags)
-- flags : QUEUE_STATUS_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetQueueStatus = lib.func('__stdcall', 'GetQueueStatus', 'uint32_t', ['uint32_t']);
// GetQueueStatus(flags)
// flags : QUEUE_STATUS_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetQueueStatus: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.GetQueueStatus(flags)
// flags : QUEUE_STATUS_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetQueueStatus(
    uint32_t flags);
C, "USER32.dll");
// $ffi->GetQueueStatus(flags);
// flags : QUEUE_STATUS_FLAGS
// 構造体/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);
    int GetQueueStatus(
        int flags   // QUEUE_STATUS_FLAGS
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetQueueStatus = GetQueueStatus(
    flags : UInt32   # QUEUE_STATUS_FLAGS
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetQueueStatusNative = Uint32 Function(Uint32);
typedef GetQueueStatusDart = int Function(int);
final GetQueueStatus = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetQueueStatusNative, GetQueueStatusDart>('GetQueueStatus');
// flags : QUEUE_STATUS_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetQueueStatus(
  flags: DWORD   // QUEUE_STATUS_FLAGS
): DWORD; stdcall;
  external 'USER32.dll' name 'GetQueueStatus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetQueueStatus"
  c_GetQueueStatus :: Word32 -> IO Word32
-- flags : QUEUE_STATUS_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getqueuestatus =
  foreign "GetQueueStatus"
    (uint32_t @-> returning uint32_t)
(* flags : QUEUE_STATUS_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetQueueStatus" get-queue-status :convention :stdcall) :uint32
  (flags :uint32))   ; QUEUE_STATUS_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetQueueStatus = Win32::API::More->new('USER32',
    'DWORD GetQueueStatus(DWORD flags)');
# my $ret = $GetQueueStatus->Call($flags);
# flags : QUEUE_STATUS_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型