Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
hFileHANDLEin
lpOverlappedOVERLAPPED*in
lpNumberOfBytesTransferredDWORD*out
bWaitBOOLin

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL GetOverlappedResult(HANDLE hFile, OVERLAPPED* lpOverlapped, DWORD* lpNumberOfBytesTransferred, BOOL bWait)
#uselib "KERNEL32.dll"
#cfunc global GetOverlappedResult "GetOverlappedResult" intptr, var, var, int
; res = GetOverlappedResult(hFile, lpOverlapped, lpNumberOfBytesTransferred, bWait)
; hFile : HANDLE -> "intptr"
; lpOverlapped : OVERLAPPED* -> "var"
; lpNumberOfBytesTransferred : DWORD* out -> "var"
; bWait : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetOverlappedResult = kernel32.NewProc("GetOverlappedResult")
)

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