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

WSARecvFrom

関数
データグラムを受信し送信元アドレスを取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSARecvFrom(
    SOCKET s,
    WSABUF* lpBuffers,
    DWORD dwBufferCount,
    DWORD* lpNumberOfBytesRecvd,   // optional
    DWORD* lpFlags,
    SOCKADDR* lpFrom,   // optional
    INT* lpFromlen,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

パラメーター

名前方向
sSOCKETin
lpBuffersWSABUF*in
dwBufferCountDWORDin
lpNumberOfBytesRecvdDWORD*outoptional
lpFlagsDWORD*inout
lpFromSOCKADDR*outoptional
lpFromlenINT*inoutoptional
lpOverlappedOVERLAPPED*inoutoptional
lpCompletionRoutineLPWSAOVERLAPPED_COMPLETION_ROUTINEinoptional

戻り値の型: INT

各言語での呼び出し定義

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

INT WSARecvFrom(
    SOCKET s,
    WSABUF* lpBuffers,
    DWORD dwBufferCount,
    DWORD* lpNumberOfBytesRecvd,   // optional
    DWORD* lpFlags,
    SOCKADDR* lpFrom,   // optional
    INT* lpFromlen,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSARecvFrom(
    UIntPtr s,   // SOCKET
    IntPtr lpBuffers,   // WSABUF*
    uint dwBufferCount,   // DWORD
    IntPtr lpNumberOfBytesRecvd,   // DWORD* optional, out
    ref uint lpFlags,   // DWORD* in/out
    IntPtr lpFrom,   // SOCKADDR* optional, out
    IntPtr lpFromlen,   // INT* optional, in/out
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpCompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSARecvFrom(
    s As UIntPtr,   ' SOCKET
    lpBuffers As IntPtr,   ' WSABUF*
    dwBufferCount As UInteger,   ' DWORD
    lpNumberOfBytesRecvd As IntPtr,   ' DWORD* optional, out
    ByRef lpFlags As UInteger,   ' DWORD* in/out
    lpFrom As IntPtr,   ' SOCKADDR* optional, out
    lpFromlen As IntPtr,   ' INT* optional, in/out
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpCompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function
' s : SOCKET
' lpBuffers : WSABUF*
' dwBufferCount : DWORD
' lpNumberOfBytesRecvd : DWORD* optional, out
' lpFlags : DWORD* in/out
' lpFrom : SOCKADDR* optional, out
' lpFromlen : INT* optional, in/out
' lpOverlapped : OVERLAPPED* optional, in/out
' lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSARecvFrom Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal lpBuffers As LongPtr, _
    ByVal dwBufferCount As Long, _
    ByVal lpNumberOfBytesRecvd As LongPtr, _
    ByRef lpFlags As Long, _
    ByVal lpFrom As LongPtr, _
    ByVal lpFromlen As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSARecvFrom = ctypes.windll.ws2_32.WSARecvFrom
WSARecvFrom.restype = ctypes.c_int
WSARecvFrom.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # lpBuffers : WSABUF*
    wintypes.DWORD,  # dwBufferCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfBytesRecvd : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpFlags : DWORD* in/out
    ctypes.c_void_p,  # lpFrom : SOCKADDR* optional, out
    ctypes.POINTER(ctypes.c_int),  # lpFromlen : INT* optional, in/out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSARecvFrom = ws2_32.NewProc("WSARecvFrom")
)

// s (SOCKET), lpBuffers (WSABUF*), dwBufferCount (DWORD), lpNumberOfBytesRecvd (DWORD* optional, out), lpFlags (DWORD* in/out), lpFrom (SOCKADDR* optional, out), lpFromlen (INT* optional, in/out), lpOverlapped (OVERLAPPED* optional, in/out), lpCompletionRoutine (LPWSAOVERLAPPED_COMPLETION_ROUTINE optional)
r1, _, err := procWSARecvFrom.Call(
	uintptr(s),
	uintptr(lpBuffers),
	uintptr(dwBufferCount),
	uintptr(lpNumberOfBytesRecvd),
	uintptr(lpFlags),
	uintptr(lpFrom),
	uintptr(lpFromlen),
	uintptr(lpOverlapped),
	uintptr(lpCompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSARecvFrom(
  s: NativeUInt;   // SOCKET
  lpBuffers: Pointer;   // WSABUF*
  dwBufferCount: DWORD;   // DWORD
  lpNumberOfBytesRecvd: Pointer;   // DWORD* optional, out
  lpFlags: Pointer;   // DWORD* in/out
  lpFrom: Pointer;   // SOCKADDR* optional, out
  lpFromlen: Pointer;   // INT* optional, in/out
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSARecvFrom';
result := DllCall("WS2_32\WSARecvFrom"
    , "UPtr", s   ; SOCKET
    , "Ptr", lpBuffers   ; WSABUF*
    , "UInt", dwBufferCount   ; DWORD
    , "Ptr", lpNumberOfBytesRecvd   ; DWORD* optional, out
    , "Ptr", lpFlags   ; DWORD* in/out
    , "Ptr", lpFrom   ; SOCKADDR* optional, out
    , "Ptr", lpFromlen   ; INT* optional, in/out
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional, in/out
    , "Ptr", lpCompletionRoutine   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    , "Int")   ; return: INT
●WSARecvFrom(s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpFrom, lpFromlen, lpOverlapped, lpCompletionRoutine) = DLL("WS2_32.dll", "int WSARecvFrom(int, void*, dword, void*, void*, void*, void*, void*, void*)")
# 呼び出し: WSARecvFrom(s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpFrom, lpFromlen, lpOverlapped, lpCompletionRoutine)
# s : SOCKET -> "int"
# lpBuffers : WSABUF* -> "void*"
# dwBufferCount : DWORD -> "dword"
# lpNumberOfBytesRecvd : DWORD* optional, out -> "void*"
# lpFlags : DWORD* in/out -> "void*"
# lpFrom : SOCKADDR* optional, out -> "void*"
# lpFromlen : INT* optional, in/out -> "void*"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。