ホーム › System.IO › GetOverlappedResult

GetOverlappedResult

関数

オーバーラップI/O操作の結果を取得する。

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

シグネチャ

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

BOOL GetOverlappedResult(
    HANDLE hFile,
    OVERLAPPED* lpOverlapped,
    DWORD* lpNumberOfBytesTransferred,
    BOOL bWait
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイル、名前付きパイプ、または通信デバイスへのハンドル。これは、次のいずれかの関数の呼び出しによってオーバーラップ操作が開始されたときに指定したものと同じハンドルです。 ReadFile WriteFile ConnectNamedPipe TransactNamedPipe DeviceIoControl WaitCommEvent ReadDirectoryChangesW LockFileEx
lpOverlapped	OVERLAPPED*	in	オーバーラップ操作が開始されたときに指定した OVERLAPPED 構造体へのポインター。
lpNumberOfBytesTransferred	DWORD*	out	読み取りまたは書き込み操作によって実際に転送されたバイト数を受け取る変数へのポインター。 TransactNamedPipe 操作の場合、これはパイプから読み取られたバイト数です。 DeviceIoControl 操作の場合、これはデバイスドライバーによって返された出力データのバイト数です。 ConnectNamedPipe または WaitCommEvent 操作の場合、この値は未定義です。
bWait	BOOL	in	このパラメーターが TRUE で、かつ lpOverlapped 構造体の Internal メンバーが STATUS_PENDING の場合、関数は操作が完了するまで返りません。このパラメーターが FALSE で操作がまだ保留中の場合、関数は FALSE を返し、 GetLastError 関数は ERROR_IO_INCOMPLETE を返します。

戻り値の型: BOOL

公式ドキュメント

指定したファイル、名前付きパイプ、または通信デバイスに対するオーバーラップ操作の結果を取得します。

戻り値

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

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

解説(Remarks)

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

bWait パラメーターが TRUE の場合、 GetOverlappedResult は、イベントオブジェクトがシグナル状態になるのを待機することによって、保留中の操作が完了したかどうかを判断します。

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

例

GetOverlappedResult を使用する例については、ファイルの終端の検査を参照してください。

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

各言語での呼び出し定義

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

BOOL GetOverlappedResult(
    HANDLE hFile,
    OVERLAPPED* lpOverlapped,
    DWORD* lpNumberOfBytesTransferred,
    BOOL bWait
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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