Win32 API 日本語リファレンス
ホームSystem.Threading › WaitForInputIdle

WaitForInputIdle

関数
プロセスが入力待ちのアイドル状態になるまで待機する。
DLLUSER32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD WaitForInputIdle(
    HANDLE hProcess,
    DWORD dwMilliseconds
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このプロセスがコンソールアプリケーションである場合、またはメッセージキューを持たない場合、 WaitForInputIdle は直ちに戻ります。
dwMillisecondsDWORDinタイムアウト間隔(ミリ秒単位)。dwMilliseconds が INFINITE の場合、関数はプロセスがアイドル状態になるまで戻りません。

戻り値の型: DWORD

公式ドキュメント

指定したプロセスが初期入力の処理を終え、保留中の入力がない状態でユーザー入力を待機するようになるまで、またはタイムアウト間隔が経過するまで待機します。

戻り値

次の表に、この関数が返す可能性のある値を示します。

リターンコード/値 説明
0
待機が正常に完了しました。
WAIT_TIMEOUT
タイムアウト間隔が経過したため、待機が終了しました。
WAIT_FAILED
エラーが発生しました。

解説(Remarks)

WaitForInputIdle 関数を使用すると、指定したプロセスが初期化を終え、保留中の入力がない状態でユーザー入力を待機するようになるまで、スレッドの実行を中断できます。プロセスが複数のスレッドを持つ場合、WaitForInputIdle 関数はいずれかのスレッドがアイドル状態になると直ちに戻ります。

WaitForInputIdle は、アプリケーションの起動時だけでなく、任意のタイミングで使用できます。ただし、WaitForInputIdle はプロセスがアイドル状態になるのを一度だけ待機します。以降の WaitForInputIdle 呼び出しは、プロセスがアイドル状態か処理中かにかかわらず、直ちに戻ります。

WaitForInputIdle は、親プロセスと新しく作成された子プロセスを同期する際に役立ちます。親プロセスが子プロセスを作成すると、 CreateProcess 関数は子プロセスの初期化完了を待たずに戻ります。子プロセスと通信を試みる前に、親プロセスは WaitForInputIdle 関数を使用して、子プロセスの初期化が完了したタイミングを判断できます。たとえば、親プロセスは子プロセスに関連付けられたウィンドウを探す前に WaitForInputIdle 関数を使用すべきです。

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

各言語での呼び出し定義

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

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

WaitForInputIdle = ctypes.windll.user32.WaitForInputIdle
WaitForInputIdle.restype = wintypes.DWORD
WaitForInputIdle.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # dwMilliseconds : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procWaitForInputIdle = user32.NewProc("WaitForInputIdle")
)

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

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

typedef WaitForInputIdleNative = Uint32 Function(Pointer<Void>, Uint32);
typedef WaitForInputIdleDart = int Function(Pointer<Void>, int);
final WaitForInputIdle = DynamicLibrary.open('USER32.dll')
    .lookupFunction<WaitForInputIdleNative, WaitForInputIdleDart>('WaitForInputIdle');
// hProcess : HANDLE -> Pointer<Void>
// dwMilliseconds : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WaitForInputIdle(
  hProcess: THandle;   // HANDLE
  dwMilliseconds: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'WaitForInputIdle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WaitForInputIdle"
  c_WaitForInputIdle :: Ptr () -> Word32 -> IO Word32
-- hProcess : HANDLE -> Ptr ()
-- dwMilliseconds : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("WaitForInputIdle" wait-for-input-idle :convention :stdcall) :uint32
  (h-process :pointer)   ; HANDLE
  (dw-milliseconds :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WaitForInputIdle = Win32::API::More->new('USER32',
    'DWORD WaitForInputIdle(HANDLE hProcess, DWORD dwMilliseconds)');
# my $ret = $WaitForInputIdle->Call($hProcess, $dwMilliseconds);
# hProcess : HANDLE -> HANDLE
# dwMilliseconds : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目