ホーム › System.IO › GetOverlappedResultEx

GetOverlappedResultEx

関数

タイムアウト指定でオーバーラップI/O結果を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL GetOverlappedResultEx(
    HANDLE hFile,
    OVERLAPPED* lpOverlapped,
    DWORD* lpNumberOfBytesTransferred,
    DWORD dwMilliseconds,
    BOOL bAlertable
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイル、名前付きパイプ、または通信デバイスへのハンドル。これは、 ReadFile、 WriteFile、 ConnectNamedPipe、 TransactNamedPipe、 DeviceIoControl、または WaitCommEvent 関数の呼び出しによってオーバーラップ操作が開始されたときに指定したものと同じハンドルです。
lpOverlapped	OVERLAPPED*	in	オーバーラップ操作の開始時に指定した OVERLAPPED 構造体へのポインター。
lpNumberOfBytesTransferred	DWORD*	out	読み取りまたは書き込み操作によって実際に転送されたバイト数を受け取る変数へのポインター。 TransactNamedPipe 操作の場合、これはパイプから読み取られたバイト数です。 DeviceIoControl 操作の場合、これはデバイスドライバーが返した出力データのバイト数です。 ConnectNamedPipe または WaitCommEvent 操作の場合、この値は未定義です。
dwMilliseconds	DWORD	in	タイムアウト間隔(ミリ秒単位)。 dwMilliseconds が 0 で、操作がまだ進行中の場合、関数はただちに戻り、GetLastError 関数は ERROR_IO_INCOMPLETE を返します。 dwMilliseconds が 0 以外で、操作がまだ進行中の場合、関数は戻る前に、オブジェクトがシグナル状態になるか、I/O 完了ルーチンまたは APC がキューに登録されるか、間隔が経過するまで待機します。拡張エラー情報を取得するには GetLastError を使用します。 dwMilliseconds が INFINITE の場合、関数はオブジェクトがシグナル状態になるか、I/O 完了ルーチンまたは APC がキューに登録された場合にのみ戻ります。 dwMilliseconds の値には、低電力状態で費やされた時間は含まれません。たとえば、コンピューターがスリープ状態の間はタイムアウトのカウントダウンは継続されません。
bAlertable	BOOL	in	このパラメーターが TRUE で、呼び出し側スレッドが待機状態にある場合、システムが I/O 完了ルーチンまたは APC をキューに登録すると関数は戻ります。その後、呼び出し側スレッドはそのルーチンまたは関数を実行します。それ以外の場合、関数は戻らず、完了ルーチンまたは APC 関数は実行されません。完了ルーチンは、それを指定した ReadFileEx または WriteFileEx 関数が完了したときにキューに登録されます。bAlertable が TRUE で、かつ呼び出し側スレッドが読み取りまたは書き込み操作を開始したスレッドである場合にのみ、関数は戻り、完了ルーチンが呼び出されます。APC は QueueUserAPC を呼び出したときにキューに登録されます。

戻り値の型: BOOL

公式ドキュメント

指定したファイル、名前付きパイプ、または通信デバイスに対するオーバーラップ操作の結果を、指定したタイムアウト間隔内で取得します。呼び出し側スレッドはアラート可能な待機を実行できます。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。一般的なエラーコードには次のものがあります。

dwMilliseconds が 0 で、操作がまだ進行中の場合、GetLastError は ERROR_IO_INCOMPLETE を返します。
dwMilliseconds が 0 以外で、I/O 完了ルーチンまたは APC がキューに登録された場合、GetLastError は WAIT_IO_COMPLETION を返します。
dwMilliseconds が 0 以外で、指定したタイムアウト間隔が経過した場合、GetLastError は WAIT_TIMEOUT を返します。

解説(Remarks)

GetOverlappedResultEx 関数は、次の点で GetOverlappedResult と異なります。dwMilliseconds パラメーターによって操作のタイムアウト間隔を指定でき、bAlertable パラメーターによって呼び出し側スレッドがアラート可能な待機を実行するよう指定できます。

GetOverlappedResultEx 関数が報告する結果は、指定した OVERLAPPED 構造体が提供され、かつ操作の結果が保留中であった、指定ハンドルの最後のオーバーラップ操作の結果です。操作を開始した関数が FALSE を返し、GetLastError 関数が ERROR_IO_PENDING を返す場合に、操作が保留中であることが示されます。I/O 操作が保留中の場合、操作を開始した関数は OVERLAPPED 構造体の hEvent メンバーを非シグナル状態にリセットします。その後、保留中の操作が完了すると、システムはイベントオブジェクトをシグナル状態に設定します。

OVERLAPPED 構造体には手動リセットのイベントオブジェクトを指定してください。自動リセットのイベントオブジェクトを使用する場合、そのイベントハンドルは、オーバーラップ操作の開始から GetOverlappedResultEx の呼び出しまでの間、他のいかなる待機操作でも指定してはなりません。たとえば、操作の完了を待機するために、いずれかの待機関数でイベントオブジェクトを指定することがあります。待機関数が戻ると、システムは自動リセットイベントの状態を非シグナルに設定するため、続いて dwMilliseconds パラメーターを INFINITE に設定して GetOverlappedResultEx を呼び出すと、関数は無期限にブロックされます。

OVERLAPPED 構造体の hEvent メンバーが NULL の場合、システムは hFile ハンドルの状態を使用して操作の完了を通知します。この目的でファイル、名前付きパイプ、または通信デバイスのハンドルを使用することは推奨されません。同じファイル、名前付きパイプ、または通信デバイスに対して複数のオーバーラップ操作が同時に実行されると混乱が生じ得るため、イベントオブジェクトを使用する方が安全です。この状況では、どの操作によってオブジェクトの状態がシグナル状態になったのかを知る方法がありません。

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

各言語での呼び出し定義

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

BOOL GetOverlappedResultEx(
    HANDLE hFile,
    OVERLAPPED* lpOverlapped,
    DWORD* lpNumberOfBytesTransferred,
    DWORD dwMilliseconds,
    BOOL bAlertable
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetOverlappedResultEx(
    IntPtr hFile,   // HANDLE
    IntPtr lpOverlapped,   // OVERLAPPED*
    out uint lpNumberOfBytesTransferred,   // DWORD* out
    uint dwMilliseconds,   // DWORD
    bool bAlertable   // BOOL
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetOverlappedResultEx(
    hFile As IntPtr,   ' HANDLE
    lpOverlapped As IntPtr,   ' OVERLAPPED*
    <Out> ByRef lpNumberOfBytesTransferred As UInteger,   ' DWORD* out
    dwMilliseconds As UInteger,   ' DWORD
    bAlertable As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' lpOverlapped : OVERLAPPED*
' lpNumberOfBytesTransferred : DWORD* out
' dwMilliseconds : DWORD
' bAlertable : BOOL
Declare PtrSafe Function GetOverlappedResultEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByRef lpNumberOfBytesTransferred As Long, _
    ByVal dwMilliseconds As Long, _
    ByVal bAlertable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetOverlappedResultEx = ctypes.windll.kernel32.GetOverlappedResultEx
GetOverlappedResultEx.restype = wintypes.BOOL
GetOverlappedResultEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfBytesTransferred : DWORD* out
    wintypes.DWORD,  # dwMilliseconds : DWORD
    wintypes.BOOL,  # bAlertable : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetOverlappedResultEx = Fiddle::Function.new(
  lib['GetOverlappedResultEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED*
    Fiddle::TYPE_VOIDP,  # lpNumberOfBytesTransferred : DWORD* out
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
    Fiddle::TYPE_INT,  # bAlertable : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetOverlappedResultEx(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED*
        lpNumberOfBytesTransferred: *mut u32,  // DWORD* out
        dwMilliseconds: u32,  // DWORD
        bAlertable: 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 GetOverlappedResultEx(IntPtr hFile, IntPtr lpOverlapped, out uint lpNumberOfBytesTransferred, uint dwMilliseconds, bool bAlertable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetOverlappedResultEx' -Namespace Win32 -PassThru
# $api::GetOverlappedResultEx(hFile, lpOverlapped, lpNumberOfBytesTransferred, dwMilliseconds, bAlertable)

#uselib "KERNEL32.dll"
#func global GetOverlappedResultEx "GetOverlappedResultEx" sptr, sptr, sptr, sptr, sptr
; GetOverlappedResultEx hFile, varptr(lpOverlapped), varptr(lpNumberOfBytesTransferred), dwMilliseconds, bAlertable   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpOverlapped : OVERLAPPED* -> "sptr"
; lpNumberOfBytesTransferred : DWORD* out -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; bAlertable : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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