ホーム › System.IO › GetQueuedCompletionStatusEx

GetQueuedCompletionStatusEx

関数

I/O完了ポートから複数の完了結果を一括取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetQueuedCompletionStatusEx(
    HANDLE CompletionPort,
    OVERLAPPED_ENTRY* lpCompletionPortEntries,
    DWORD ulCount,
    DWORD* ulNumEntriesRemoved,
    DWORD dwMilliseconds,
    BOOL fAlertable
);

パラメーター

名前	型	方向	説明
CompletionPort	HANDLE	in	完了ポートへのハンドル。完了ポートを作成するには、 CreateIoCompletionPort 関数を使用します。
lpCompletionPortEntries	OVERLAPPED_ENTRY*	out	入力時には、事前に割り当てられた OVERLAPPED_ENTRY 構造体の配列を指します。出力時には、エントリを保持する OVERLAPPED_ENTRY 構造体の配列を受け取ります。配列要素の数は ulNumEntriesRemoved によって提供されます。各 I/O で転送されたバイト数、各 I/O がどのファイルで発生したかを示す完了キー、および各元の I/O で使用されたオーバーラップ構造体のアドレスは、すべて lpCompletionPortEntries 配列で返されます。
ulCount	DWORD	in	削除するエントリの最大数。
ulNumEntriesRemoved	DWORD*	out	実際に削除されたエントリの数を受け取る変数へのポインター。
dwMilliseconds	DWORD	in	完了ポートに完了パケットが現れるのを呼び出し元が待機する時間 (ミリ秒単位)。指定された時間内に完了パケットが現れない場合、関数はタイムアウトして FALSE を返します。 dwMilliseconds が INFINITE (0xFFFFFFFF) の場合、関数は決してタイムアウトしません。dwMilliseconds がゼロで、デキューする I/O 操作がない場合、関数は直ちにタイムアウトします。 Windows XP、Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008、Windows Server 2008 R2: dwMilliseconds の値には、低電力状態で費やされた時間が含まれます。たとえば、コンピューターがスリープ状態の間もタイムアウトのカウントダウンは継続します。 Windows 8 以降、Windows Server 2012 以降: dwMilliseconds の値には、低電力状態で費やされた時間は含まれません。たとえば、コンピューターがスリープ状態の間はタイムアウトのカウントダウンは継続しません。
fAlertable	BOOL	in	このパラメーターが FALSE の場合、関数はタイムアウト期間が経過するか、エントリが取得されるまで返りません。パラメーターが TRUE で利用可能なエントリがない場合、関数はアラート可能な待機を実行します。システムが I/O 完了ルーチンまたは APC をスレッドにキューイングし、そのスレッドが関数を実行すると、スレッドは返ります。完了ルーチンは、それが指定された ReadFileEx または WriteFileEx 関数が完了し、呼び出し元スレッドがその操作を開始したスレッドである場合にキューイングされます。APC は QueueUserAPC を呼び出したときにキューイングされます。

戻り値の型: BOOL

公式ドキュメント

複数の完了ポートエントリを同時に取得します。

戻り値

成功した場合は非ゼロ (TRUE) を、それ以外の場合はゼロ (FALSE) を返します。

拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

この関数は、スレッドを指定された完了ポートに関連付けます。スレッドは最大で 1 つの完了ポートにのみ関連付けることができます。

この関数は、少なくとも 1 つの保留中の I/O が完了したときに TRUE を返しますが、1 つ以上の I/O 操作が失敗している可能性があります。各 OVERLAPPED_ENTRY の lpOverlapped メンバーに含まれるステータスを調べることで、lpCompletionPortEntries パラメーターで返されたエントリのリストのうち、どれが失敗した可能性のある I/O 操作に対応するかを判断するのは、この関数の利用者の責任であることに注意してください。

この関数は、I/O 操作がデキューされなかったときに FALSE を返します。これは通常、この呼び出しのパラメーターの処理中にエラーが発生したか、CompletionPort ハンドルが閉じられているか、またはその他の理由で無効であることを意味します。 GetLastError 関数が拡張エラー情報を提供します。

GetQueuedCompletionStatusEx の呼び出しが、それに関連付けられたハンドルが閉じられたために失敗した場合、関数は FALSE を返し、 GetLastError は ERROR_ABANDONED_WAIT_0 を返します。

サーバーアプリケーションでは、同じ完了ポートに対して複数のスレッドが GetQueuedCompletionStatusEx 関数を呼び出すことがあります。I/O 操作が完了すると、それらは先入れ先出し (first-in-first-out) の順序でこのポートにキューイングされます。スレッドがこの呼び出しでアクティブに待機している場合、1 つ以上のキューイングされた要求は、そのスレッドに対してのみ呼び出しを完了させます。

I/O 完了ポートの理論、使用法、および関連する関数の詳細については、 I/O Completion Ports を参照してください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 Transparent Failover (TFO)	はい
SMB 3.0 with Scale-out File Shares (SO)	はい
Cluster Shared Volume File System (CsvFS)	はい
Resilient File System (ReFS)	はい

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

各言語での呼び出し定義

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

BOOL GetQueuedCompletionStatusEx(
    HANDLE CompletionPort,
    OVERLAPPED_ENTRY* lpCompletionPortEntries,
    DWORD ulCount,
    DWORD* ulNumEntriesRemoved,
    DWORD dwMilliseconds,
    BOOL fAlertable
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetQueuedCompletionStatusEx(
    IntPtr CompletionPort,   // HANDLE
    IntPtr lpCompletionPortEntries,   // OVERLAPPED_ENTRY* out
    uint ulCount,   // DWORD
    out uint ulNumEntriesRemoved,   // DWORD* out
    uint dwMilliseconds,   // DWORD
    bool fAlertable   // BOOL
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetQueuedCompletionStatusEx(
    CompletionPort As IntPtr,   ' HANDLE
    lpCompletionPortEntries As IntPtr,   ' OVERLAPPED_ENTRY* out
    ulCount As UInteger,   ' DWORD
    <Out> ByRef ulNumEntriesRemoved As UInteger,   ' DWORD* out
    dwMilliseconds As UInteger,   ' DWORD
    fAlertable As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' CompletionPort : HANDLE
' lpCompletionPortEntries : OVERLAPPED_ENTRY* out
' ulCount : DWORD
' ulNumEntriesRemoved : DWORD* out
' dwMilliseconds : DWORD
' fAlertable : BOOL
Declare PtrSafe Function GetQueuedCompletionStatusEx Lib "kernel32" ( _
    ByVal CompletionPort As LongPtr, _
    ByVal lpCompletionPortEntries As LongPtr, _
    ByVal ulCount As Long, _
    ByRef ulNumEntriesRemoved As Long, _
    ByVal dwMilliseconds As Long, _
    ByVal fAlertable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetQueuedCompletionStatusEx = ctypes.windll.kernel32.GetQueuedCompletionStatusEx
GetQueuedCompletionStatusEx.restype = wintypes.BOOL
GetQueuedCompletionStatusEx.argtypes = [
    wintypes.HANDLE,  # CompletionPort : HANDLE
    ctypes.c_void_p,  # lpCompletionPortEntries : OVERLAPPED_ENTRY* out
    wintypes.DWORD,  # ulCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ulNumEntriesRemoved : DWORD* out
    wintypes.DWORD,  # dwMilliseconds : DWORD
    wintypes.BOOL,  # fAlertable : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetQueuedCompletionStatusEx = Fiddle::Function.new(
  lib['GetQueuedCompletionStatusEx'],
  [
    Fiddle::TYPE_VOIDP,  # CompletionPort : HANDLE
    Fiddle::TYPE_VOIDP,  # lpCompletionPortEntries : OVERLAPPED_ENTRY* out
    -Fiddle::TYPE_INT,  # ulCount : DWORD
    Fiddle::TYPE_VOIDP,  # ulNumEntriesRemoved : DWORD* out
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
    Fiddle::TYPE_INT,  # fAlertable : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetQueuedCompletionStatusEx(
        CompletionPort: *mut core::ffi::c_void,  // HANDLE
        lpCompletionPortEntries: *mut OVERLAPPED_ENTRY,  // OVERLAPPED_ENTRY* out
        ulCount: u32,  // DWORD
        ulNumEntriesRemoved: *mut u32,  // DWORD* out
        dwMilliseconds: u32,  // DWORD
        fAlertable: i32  // BOOL
    ) -> 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 GetQueuedCompletionStatusEx(IntPtr CompletionPort, IntPtr lpCompletionPortEntries, uint ulCount, out uint ulNumEntriesRemoved, uint dwMilliseconds, bool fAlertable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetQueuedCompletionStatusEx' -Namespace Win32 -PassThru
# $api::GetQueuedCompletionStatusEx(CompletionPort, lpCompletionPortEntries, ulCount, ulNumEntriesRemoved, dwMilliseconds, fAlertable)

#uselib "KERNEL32.dll"
#func global GetQueuedCompletionStatusEx "GetQueuedCompletionStatusEx" sptr, sptr, sptr, sptr, sptr, sptr
; GetQueuedCompletionStatusEx CompletionPort, varptr(lpCompletionPortEntries), ulCount, varptr(ulNumEntriesRemoved), dwMilliseconds, fAlertable   ; 戻り値は stat
; CompletionPort : HANDLE -> "sptr"
; lpCompletionPortEntries : OVERLAPPED_ENTRY* out -> "sptr"
; ulCount : DWORD -> "sptr"
; ulNumEntriesRemoved : DWORD* out -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; fAlertable : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetQueuedCompletionStatusEx "GetQueuedCompletionStatusEx" sptr, var, int, var, int, int
; res = GetQueuedCompletionStatusEx(CompletionPort, lpCompletionPortEntries, ulCount, ulNumEntriesRemoved, dwMilliseconds, fAlertable)
; CompletionPort : HANDLE -> "sptr"
; lpCompletionPortEntries : OVERLAPPED_ENTRY* out -> "var"
; ulCount : DWORD -> "int"
; ulNumEntriesRemoved : DWORD* out -> "var"
; dwMilliseconds : DWORD -> "int"
; fAlertable : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetQueuedCompletionStatusEx "GetQueuedCompletionStatusEx" sptr, sptr, int, sptr, int, int
; res = GetQueuedCompletionStatusEx(CompletionPort, varptr(lpCompletionPortEntries), ulCount, varptr(ulNumEntriesRemoved), dwMilliseconds, fAlertable)
; CompletionPort : HANDLE -> "sptr"
; lpCompletionPortEntries : OVERLAPPED_ENTRY* out -> "sptr"
; ulCount : DWORD -> "int"
; ulNumEntriesRemoved : DWORD* out -> "sptr"
; dwMilliseconds : DWORD -> "int"
; fAlertable : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。