ホーム › 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
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	ソケットを識別するディスクリプタです。これは、オーバーラップ操作をサポートする Winsock 関数のいずれかを呼び出してオーバーラップ操作を開始したときに指定したソケットと同じものです。これらの関数には、AcceptEx、ConnectEx、DisconnectEx、TransmitFile、TransmitPackets、WSARecv、 WSARecvFrom、 LPFN_WSARECVMSG (WSARecvMsg)、WSASend、 WSASendMsg、WSASendTo、および WSAIoctl が含まれます。
lpOverlapped	OVERLAPPED*	in	オーバーラップ操作を開始したときに指定した WSAOVERLAPPED 構造体へのポインタです。このパラメータを NULL ポインタにすることはできません。
lpcbTransfer	DWORD*	out	送信または受信操作、あるいは WSAIoctl 関数によって実際に転送されたバイト数を受け取る 32 ビット変数へのポインタです。このパラメータを NULL ポインタにすることはできません。
fWait	BOOL	in	保留中のオーバーラップ操作が完了するまで関数が待機するかどうかを指定するフラグです。TRUE の場合、操作が完了するまで関数は戻りません。FALSE で操作がまだ保留中の場合、関数は FALSE を返し、 WSAGetLastError 関数は WSA_IO_INCOMPLETE を返します。fWait パラメータを TRUE に設定できるのは、オーバーラップ操作がイベントベースの完了通知を選択している場合のみです。
lpdwFlags	DWORD*	out	完了状態を補足する 1 つ以上のフラグを受け取る 32 ビット変数へのポインタです。オーバーラップ操作が WSARecv または WSARecvFrom を通じて開始された場合、このパラメータには lpFlags パラメータの結果値が格納されます。このパラメータを NULL ポインタにすることはできません。

戻り値の型: BOOL

公式ドキュメント

WSAGetOverlappedResult 関数は、指定したソケットに対するオーバーラップ操作の結果を取得します。

戻り値

WSAGetOverlappedResult が成功すると、戻り値は TRUE です。これは、オーバーラップ操作が正常に完了し、lpcbTransfer が指す値が更新されたことを意味します。

WSAGetOverlappedResult が FALSE を返した場合、これはオーバーラップ操作がまだ完了していないか、オーバーラップ操作はエラーを伴って完了したか、または WSAGetOverlappedResult への 1 つ以上のパラメータのエラーによりオーバーラップ操作の完了状態を判別できなかったことを意味します。失敗した場合、lpcbTransfer が指す値は更新されません。失敗の原因(WSAGetOverlappedResult 関数によるものか、関連するオーバーラップ操作によるものか)を判別するには、 WSAGetLastError を使用してください。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAENOTSOCK	ディスクリプタがソケットではありません。
WSA_INVALID_HANDLE	WSAOVERLAPPED 構造体の hEvent パラメータに、有効なイベントオブジェクトハンドルが含まれていません。
WSA_INVALID_PARAMETER	パラメータの 1 つが受け入れられません。
WSA_IO_INCOMPLETE	fWait パラメータが FALSE で、I/O 操作がまだ完了していません。
WSAEFAULT	lpOverlapped、lpcbTransfer、または lpdwFlags パラメータの 1 つ以上が、ユーザーアドレス空間の有効な部分にありません。このエラーは、Windows Server 2003 以前で lpOverlapped、lpcbTransfer、または lpdwFlags パラメータが NULL ポインタだった場合に返されます。

解説(Remarks)

WSAGetOverlappedResult 関数は、s パラメータで指定したソケットについて、lpOverlapped パラメータで指定したオーバーラップ操作の結果を報告します。WSAGetOverlappedResult 関数には、オーバーラップ関数が呼び出されたときに指定したソケットディスクリプタと WSAOVERLAPPED 構造体が渡されます。保留中の操作は、操作を開始した関数が FALSE を返し、 WSAGetLastError 関数が WSA_IO_PENDING を返すことで示されます。 WSARecv などの I/O 操作が保留中の場合、操作を開始した関数は WSAOVERLAPPED 構造体の hEvent メンバーを非シグナル状態にリセットします。その後、保留中の操作が完了すると、システムはイベントオブジェクトをシグナル状態に設定します。

fWait パラメータが TRUE の場合、 WSAGetOverlappedResult は、イベントオブジェクトがシグナル状態になるのを待機することで、保留中の操作が完了したかどうかを判別します。クライアントは fWait パラメータを TRUE に設定できますが、I/O 操作を要求したときにイベントベースの完了通知を選択した場合に限ります。別の形式の通知を選択した場合、 WSAOVERLAPPED 構造体の hEvent パラメータの用途は異なり、fWait を TRUE に設定すると予測できない結果を招きます。

Windows Vista で lpOverlapped、lpcbTransfer、または lpdwFlags パラメータを NULL ポインタに設定して WSAGetOverlappedResult 関数を呼び出すと、アクセス違反が発生します。Windows Server 2003 以前で lpOverlapped、lpcbTransfer、または lpdwFlags パラメータを NULL ポインタに設定して WSAGetOverlappedResult 関数を呼び出すと、WSAEFAULT エラーコードが返されます。

注意スレッドが終了すると、すべての I/O はキャンセルされます。オーバーラップソケットの場合、操作が完了する前にスレッドが閉じられると、保留中の非同期操作は失敗することがあります。詳細については、ExitThread を参照してください。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAGetOverlappedResult "WSAGetOverlappedResult" sptr, sptr, sptr, int, sptr
; res = WSAGetOverlappedResult(s, varptr(lpOverlapped), varptr(lpcbTransfer), fWait, varptr(lpdwFlags))
; s : SOCKET -> "sptr"
; lpOverlapped : OVERLAPPED* -> "sptr"
; lpcbTransfer : DWORD* out -> "sptr"
; fWait : BOOL -> "int"
; lpdwFlags : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。