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

WaitMessage

関数
メッセージがキューに届くまでスレッドを待機させる。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL WaitMessage(void);

パラメーターなし。戻り値: BOOL

公式ドキュメント

スレッドのメッセージキューに処理すべきメッセージが他にない場合に、他のスレッドへ制御を譲ります。WaitMessage 関数はスレッドを中断し、新しいメッセージがスレッドのメッセージキューに配置されるまで処理を返しません。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

WaitMessage は、キューを確認する以前の関数によって報告された未処理のメッセージについては処理を返さない点に注意してください。これは、PeekMessageGetMessageGetQueueStatusWaitMessageMsgWaitForMultipleObjectsMsgWaitForMultipleObjectsEx といった関数がキューを確認した後にキューの状態情報を変更し、そのメッセージが新しいものとは見なされなくなるためです。その後の WaitMessage の呼び出しは、新しいメッセージが到着するまで処理を返しません。既存の未処理メッセージ(スレッドが前回キューを確認した時点より前に受信したもの)は、新しいものとは見なされません。

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

各言語での呼び出し定義

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

BOOL WaitMessage(void);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WaitMessage();
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitMessage() As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
Declare PtrSafe Function WaitMessage Lib "user32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WaitMessage = ctypes.windll.user32.WaitMessage
WaitMessage.restype = wintypes.BOOL
WaitMessage.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procWaitMessage = user32.NewProc("WaitMessage")
)

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

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

typedef WaitMessageNative = Int32 Function();
typedef WaitMessageDart = int Function();
final WaitMessage = DynamicLibrary.open('USER32.dll')
    .lookupFunction<WaitMessageNative, WaitMessageDart>('WaitMessage');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WaitMessage: BOOL; stdcall;
  external 'USER32.dll' name 'WaitMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

公式の関連項目