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

パラメーター

名前方向
hFileHANDLEin
lpOverlappedOVERLAPPED*in
lpNumberOfBytesTransferredDWORD*out
dwMillisecondsDWORDin
bAlertableBOOLin

戻り値の型: BOOL

各言語での呼び出し定義

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetOverlappedResultEx = kernel32.NewProc("GetOverlappedResultEx")
)

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