Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSAGetOverlappedResult

WSAGetOverlappedResult

関数
オーバーラップ操作の完了結果を取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

BOOL WSAGetOverlappedResult(
    SOCKET s,
    OVERLAPPED* lpOverlapped,
    DWORD* lpcbTransfer,
    BOOL fWait,
    DWORD* lpdwFlags
);

パラメーター

名前方向
sSOCKETin
lpOverlappedOVERLAPPED*in
lpcbTransferDWORD*out
fWaitBOOLin
lpdwFlagsDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WSAGetOverlappedResult(
    SOCKET s,
    OVERLAPPED* lpOverlapped,
    DWORD* lpcbTransfer,
    BOOL fWait,
    DWORD* lpdwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WSAGetOverlappedResult(
    UIntPtr s,   // SOCKET
    IntPtr lpOverlapped,   // OVERLAPPED*
    out uint lpcbTransfer,   // DWORD* out
    bool fWait,   // BOOL
    out uint lpdwFlags   // DWORD* out
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetOverlappedResult(
    s As UIntPtr,   ' SOCKET
    lpOverlapped As IntPtr,   ' OVERLAPPED*
    <Out> ByRef lpcbTransfer As UInteger,   ' DWORD* out
    fWait As Boolean,   ' BOOL
    <Out> ByRef lpdwFlags As UInteger   ' DWORD* out
) As Boolean
End Function
' s : SOCKET
' lpOverlapped : OVERLAPPED*
' lpcbTransfer : DWORD* out
' fWait : BOOL
' lpdwFlags : DWORD* out
Declare PtrSafe Function WSAGetOverlappedResult Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByRef lpcbTransfer As Long, _
    ByVal fWait As Long, _
    ByRef lpdwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAGetOverlappedResult = ctypes.windll.ws2_32.WSAGetOverlappedResult
WSAGetOverlappedResult.restype = wintypes.BOOL
WSAGetOverlappedResult.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
    ctypes.POINTER(wintypes.DWORD),  # lpcbTransfer : DWORD* out
    wintypes.BOOL,  # fWait : BOOL
    ctypes.POINTER(wintypes.DWORD),  # lpdwFlags : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAGetOverlappedResult = Fiddle::Function.new(
  lib['WSAGetOverlappedResult'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED*
    Fiddle::TYPE_VOIDP,  # lpcbTransfer : DWORD* out
    Fiddle::TYPE_INT,  # fWait : BOOL
    Fiddle::TYPE_VOIDP,  # lpdwFlags : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn WSAGetOverlappedResult(
        s: usize,  // SOCKET
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED*
        lpcbTransfer: *mut u32,  // DWORD* out
        fWait: i32,  // BOOL
        lpdwFlags: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern bool WSAGetOverlappedResult(UIntPtr s, IntPtr lpOverlapped, out uint lpcbTransfer, bool fWait, out uint lpdwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetOverlappedResult' -Namespace Win32 -PassThru
# $api::WSAGetOverlappedResult(s, lpOverlapped, lpcbTransfer, fWait, lpdwFlags)
#uselib "WS2_32.dll"
#func global WSAGetOverlappedResult "WSAGetOverlappedResult" sptr, sptr, sptr, sptr, sptr
; WSAGetOverlappedResult s, varptr(lpOverlapped), varptr(lpcbTransfer), fWait, varptr(lpdwFlags)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; lpOverlapped : OVERLAPPED* -> "sptr"
; lpcbTransfer : DWORD* out -> "sptr"
; fWait : BOOL -> "sptr"
; lpdwFlags : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSAGetOverlappedResult "WSAGetOverlappedResult" sptr, var, var, int, var
; res = WSAGetOverlappedResult(s, lpOverlapped, lpcbTransfer, fWait, lpdwFlags)
; s : SOCKET -> "sptr"
; lpOverlapped : OVERLAPPED* -> "var"
; lpcbTransfer : DWORD* out -> "var"
; fWait : BOOL -> "int"
; lpdwFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WSAGetOverlappedResult(SOCKET s, OVERLAPPED* lpOverlapped, DWORD* lpcbTransfer, BOOL fWait, DWORD* lpdwFlags)
#uselib "WS2_32.dll"
#cfunc global WSAGetOverlappedResult "WSAGetOverlappedResult" intptr, var, var, int, var
; res = WSAGetOverlappedResult(s, lpOverlapped, lpcbTransfer, fWait, lpdwFlags)
; s : SOCKET -> "intptr"
; lpOverlapped : OVERLAPPED* -> "var"
; lpcbTransfer : DWORD* out -> "var"
; fWait : BOOL -> "int"
; lpdwFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAGetOverlappedResult = ws2_32.NewProc("WSAGetOverlappedResult")
)

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