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

GetThreadIOPendingFlag

関数
指定スレッドにI/O待ち要求があるか取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetThreadIOPendingFlag(
    HANDLE hThread,
    BOOL* lpIOIsPending
);

パラメーター

名前方向説明
hThreadHANDLEin対象となるスレッドのハンドルです。このハンドルは THREAD_QUERY_INFORMATION アクセス権を付与して作成されている必要があります。詳細については、Thread Security and Access Rights を参照してください。
lpIOIsPendingBOOL*out変数へのポインターです。指定したスレッドに 1 つ以上の保留中の I/O 要求がある場合、関数はこの変数を TRUE に設定し、そうでない場合は FALSE に設定します。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドに保留中の I/O 要求があるかどうかを判定します。

戻り値

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

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

解説(Remarks)

指定したスレッドの I/O 状態は急速に変化する可能性があり、関数が返る時点ですでに変化している場合があることに注意してください。たとえば、保留中の I/O 操作は、関数が lpIOIsPending を設定してから関数が返るまでの間に完了する可能性があります。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0501 以降として定義してください。詳細については、 Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

BOOL GetThreadIOPendingFlag(
    HANDLE hThread,
    BOOL* lpIOIsPending
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetThreadIOPendingFlag(
    IntPtr hThread,   // HANDLE
    out bool lpIOIsPending   // BOOL* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetThreadIOPendingFlag(
    hThread As IntPtr,   ' HANDLE
    <Out> ByRef lpIOIsPending As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hThread : HANDLE
' lpIOIsPending : BOOL* out
Declare PtrSafe Function GetThreadIOPendingFlag Lib "kernel32" ( _
    ByVal hThread As LongPtr, _
    ByRef lpIOIsPending As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetThreadIOPendingFlag = ctypes.windll.kernel32.GetThreadIOPendingFlag
GetThreadIOPendingFlag.restype = wintypes.BOOL
GetThreadIOPendingFlag.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_void_p,  # lpIOIsPending : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetThreadIOPendingFlag = Fiddle::Function.new(
  lib['GetThreadIOPendingFlag'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_VOIDP,  # lpIOIsPending : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetThreadIOPendingFlag(
        hThread: *mut core::ffi::c_void,  // HANDLE
        lpIOIsPending: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetThreadIOPendingFlag(IntPtr hThread, out bool lpIOIsPending);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetThreadIOPendingFlag' -Namespace Win32 -PassThru
# $api::GetThreadIOPendingFlag(hThread, lpIOIsPending)
#uselib "KERNEL32.dll"
#func global GetThreadIOPendingFlag "GetThreadIOPendingFlag" sptr, sptr
; GetThreadIOPendingFlag hThread, varptr(lpIOIsPending)   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; lpIOIsPending : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetThreadIOPendingFlag "GetThreadIOPendingFlag" sptr, var
; res = GetThreadIOPendingFlag(hThread, lpIOIsPending)
; hThread : HANDLE -> "sptr"
; lpIOIsPending : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetThreadIOPendingFlag(HANDLE hThread, BOOL* lpIOIsPending)
#uselib "KERNEL32.dll"
#cfunc global GetThreadIOPendingFlag "GetThreadIOPendingFlag" intptr, var
; res = GetThreadIOPendingFlag(hThread, lpIOIsPending)
; hThread : HANDLE -> "intptr"
; lpIOIsPending : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetThreadIOPendingFlag = kernel32.NewProc("GetThreadIOPendingFlag")
)

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

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

typedef GetThreadIOPendingFlagNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef GetThreadIOPendingFlagDart = int Function(Pointer<Void>, Pointer<Int32>);
final GetThreadIOPendingFlag = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetThreadIOPendingFlagNative, GetThreadIOPendingFlagDart>('GetThreadIOPendingFlag');
// hThread : HANDLE -> Pointer<Void>
// lpIOIsPending : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetThreadIOPendingFlag(
  hThread: THandle;   // HANDLE
  lpIOIsPending: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetThreadIOPendingFlag';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetThreadIOPendingFlag"
  c_GetThreadIOPendingFlag :: Ptr () -> Ptr CInt -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- lpIOIsPending : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getthreadiopendingflag =
  foreign "GetThreadIOPendingFlag"
    ((ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* lpIOIsPending : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetThreadIOPendingFlag" get-thread-iopending-flag :convention :stdcall) :int32
  (h-thread :pointer)   ; HANDLE
  (lp-iois-pending :pointer))   ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetThreadIOPendingFlag = Win32::API::More->new('KERNEL32',
    'BOOL GetThreadIOPendingFlag(HANDLE hThread, LPVOID lpIOIsPending)');
# my $ret = $GetThreadIOPendingFlag->Call($hThread, $lpIOIsPending);
# hThread : HANDLE -> HANDLE
# lpIOIsPending : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。