ホーム › Networking.WinSock › GetAcceptExSockaddrs

GetAcceptExSockaddrs

関数

AcceptExの出力バッファからローカルとリモートのアドレスを解析する。

DLLMSWSOCK.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

void GetAcceptExSockaddrs(
    void* lpOutputBuffer,
    DWORD dwReceiveDataLength,
    DWORD dwLocalAddressLength,
    DWORD dwRemoteAddressLength,
    SOCKADDR** LocalSockaddr,
    INT* LocalSockaddrLength,
    SOCKADDR** RemoteSockaddr,
    INT* RemoteSockaddrLength
);

パラメーター

名前	型	方向	説明
lpOutputBuffer	void*	in	AcceptEx 呼び出しによって確立された接続で最初に送信されるデータブロックを受け取るバッファへのポインターです。AcceptEx 関数に渡したものと同じ lpOutputBuffer パラメーターである必要があります。
dwReceiveDataLength	DWORD	in	最初のデータの受信に使用されるバッファ内のバイト数です。この値は、 AcceptEx 関数に渡した dwReceiveDataLength パラメーターと等しい必要があります。
dwLocalAddressLength	DWORD	in	ローカルアドレス情報のために予約されているバイト数です。この値は、 AcceptEx 関数に渡した dwLocalAddressLength パラメーターと等しい必要があります。
dwRemoteAddressLength	DWORD	in	リモートアドレス情報のために予約されているバイト数です。この値は、 AcceptEx 関数に渡した dwRemoteAddressLength パラメーターと等しい必要があります。
LocalSockaddr	SOCKADDR**	out	接続のローカルアドレスを受け取る sockaddr 構造体へのポインターです ( getsockname 関数が返すものと同じ情報)。このパラメーターは必ず指定する必要があります。
LocalSockaddrLength	INT*	out	ローカルアドレスのサイズ (バイト単位) です。このパラメーターは必ず指定する必要があります。
RemoteSockaddr	SOCKADDR**	out	接続のリモートアドレスを受け取る sockaddr 構造体へのポインターです ( getpeername 関数が返すものと同じ情報)。このパラメーターは必ず指定する必要があります。
RemoteSockaddrLength	INT*	out	ローカルアドレスのサイズ (バイト単位) です。このパラメーターは必ず指定する必要があります。

戻り値の型: void

公式ドキュメント

GetAcceptExSockaddrs 関数 (mswsock.h) は、AcceptEx 関数の呼び出しによって取得したデータを解析し、ローカルアドレスとリモートアドレスを sockaddr 構造体に渡します。

解説(Remarks)

GetAcceptExSockaddrs 関数は、 AcceptEx 関数と組み合わせてのみ使用され、ソケットが受信した最初のデータをローカルアドレスとリモートアドレスに解析します。 AcceptEx 関数は、ローカルアドレスとリモートアドレスの情報を内部形式で返します。アプリケーション開発者は、ローカルアドレスまたはリモートアドレスを含む sockaddr 構造体が必要な場合に GetAcceptExSockaddrs 関数を使用する必要があります。

注意 GetAcceptExSockaddrs 関数の関数ポインターは、SIO_GET_EXTENSION_FUNCTION_POINTER オペコードを指定して WSAIoctl 関数を呼び出すことにより、実行時に取得する必要があります。WSAIoctl 関数に渡される入力バッファには、GetAcceptExSockaddrs 拡張関数を識別する値を持つグローバル一意識別子 (GUID) である WSAID_GETACCEPTEXSOCKADDRS を含める必要があります。成功すると、WSAIoctl 関数が返す出力には GetAcceptExSockaddrs 関数へのポインターが含まれます。WSAID_GETACCEPTEXSOCKADDRS GUID は Mswsock.h ヘッダーファイルで定義されています。

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)

各言語での呼び出し定義

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

void GetAcceptExSockaddrs(
    void* lpOutputBuffer,
    DWORD dwReceiveDataLength,
    DWORD dwLocalAddressLength,
    DWORD dwRemoteAddressLength,
    SOCKADDR** LocalSockaddr,
    INT* LocalSockaddrLength,
    SOCKADDR** RemoteSockaddr,
    INT* RemoteSockaddrLength
);

[DllImport("MSWSOCK.dll", ExactSpelling = true)]
static extern void GetAcceptExSockaddrs(
    IntPtr lpOutputBuffer,   // void*
    uint dwReceiveDataLength,   // DWORD
    uint dwLocalAddressLength,   // DWORD
    uint dwRemoteAddressLength,   // DWORD
    IntPtr LocalSockaddr,   // SOCKADDR** out
    out int LocalSockaddrLength,   // INT* out
    IntPtr RemoteSockaddr,   // SOCKADDR** out
    out int RemoteSockaddrLength   // INT* out
);

<DllImport("MSWSOCK.dll", ExactSpelling:=True)>
Public Shared Sub GetAcceptExSockaddrs(
    lpOutputBuffer As IntPtr,   ' void*
    dwReceiveDataLength As UInteger,   ' DWORD
    dwLocalAddressLength As UInteger,   ' DWORD
    dwRemoteAddressLength As UInteger,   ' DWORD
    LocalSockaddr As IntPtr,   ' SOCKADDR** out
    <Out> ByRef LocalSockaddrLength As Integer,   ' INT* out
    RemoteSockaddr As IntPtr,   ' SOCKADDR** out
    <Out> ByRef RemoteSockaddrLength As Integer   ' INT* out
)
End Sub

' lpOutputBuffer : void*
' dwReceiveDataLength : DWORD
' dwLocalAddressLength : DWORD
' dwRemoteAddressLength : DWORD
' LocalSockaddr : SOCKADDR** out
' LocalSockaddrLength : INT* out
' RemoteSockaddr : SOCKADDR** out
' RemoteSockaddrLength : INT* out
Declare PtrSafe Sub GetAcceptExSockaddrs Lib "mswsock" ( _
    ByVal lpOutputBuffer As LongPtr, _
    ByVal dwReceiveDataLength As Long, _
    ByVal dwLocalAddressLength As Long, _
    ByVal dwRemoteAddressLength As Long, _
    ByVal LocalSockaddr As LongPtr, _
    ByRef LocalSockaddrLength As Long, _
    ByVal RemoteSockaddr As LongPtr, _
    ByRef RemoteSockaddrLength As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAcceptExSockaddrs = ctypes.windll.mswsock.GetAcceptExSockaddrs
GetAcceptExSockaddrs.restype = None
GetAcceptExSockaddrs.argtypes = [
    ctypes.POINTER(None),  # lpOutputBuffer : void*
    wintypes.DWORD,  # dwReceiveDataLength : DWORD
    wintypes.DWORD,  # dwLocalAddressLength : DWORD
    wintypes.DWORD,  # dwRemoteAddressLength : DWORD
    ctypes.c_void_p,  # LocalSockaddr : SOCKADDR** out
    ctypes.POINTER(ctypes.c_int),  # LocalSockaddrLength : INT* out
    ctypes.c_void_p,  # RemoteSockaddr : SOCKADDR** out
    ctypes.POINTER(ctypes.c_int),  # RemoteSockaddrLength : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSWSOCK.dll')
GetAcceptExSockaddrs = Fiddle::Function.new(
  lib['GetAcceptExSockaddrs'],
  [
    Fiddle::TYPE_VOIDP,  # lpOutputBuffer : void*
    -Fiddle::TYPE_INT,  # dwReceiveDataLength : DWORD
    -Fiddle::TYPE_INT,  # dwLocalAddressLength : DWORD
    -Fiddle::TYPE_INT,  # dwRemoteAddressLength : DWORD
    Fiddle::TYPE_VOIDP,  # LocalSockaddr : SOCKADDR** out
    Fiddle::TYPE_VOIDP,  # LocalSockaddrLength : INT* out
    Fiddle::TYPE_VOIDP,  # RemoteSockaddr : SOCKADDR** out
    Fiddle::TYPE_VOIDP,  # RemoteSockaddrLength : INT* out
  ],
  Fiddle::TYPE_VOID)

#[link(name = "mswsock")]
extern "system" {
    fn GetAcceptExSockaddrs(
        lpOutputBuffer: *mut (),  // void*
        dwReceiveDataLength: u32,  // DWORD
        dwLocalAddressLength: u32,  // DWORD
        dwRemoteAddressLength: u32,  // DWORD
        LocalSockaddr: *mut *mut SOCKADDR,  // SOCKADDR** out
        LocalSockaddrLength: *mut i32,  // INT* out
        RemoteSockaddr: *mut *mut SOCKADDR,  // SOCKADDR** out
        RemoteSockaddrLength: *mut i32  // INT* out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSWSOCK.dll")]
public static extern void GetAcceptExSockaddrs(IntPtr lpOutputBuffer, uint dwReceiveDataLength, uint dwLocalAddressLength, uint dwRemoteAddressLength, IntPtr LocalSockaddr, out int LocalSockaddrLength, IntPtr RemoteSockaddr, out int RemoteSockaddrLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSWSOCK_GetAcceptExSockaddrs' -Namespace Win32 -PassThru
# $api::GetAcceptExSockaddrs(lpOutputBuffer, dwReceiveDataLength, dwLocalAddressLength, dwRemoteAddressLength, LocalSockaddr, LocalSockaddrLength, RemoteSockaddr, RemoteSockaddrLength)

#uselib "MSWSOCK.dll"
#func global GetAcceptExSockaddrs "GetAcceptExSockaddrs" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetAcceptExSockaddrs lpOutputBuffer, dwReceiveDataLength, dwLocalAddressLength, dwRemoteAddressLength, varptr(LocalSockaddr), varptr(LocalSockaddrLength), varptr(RemoteSockaddr), varptr(RemoteSockaddrLength)
; lpOutputBuffer : void* -> "sptr"
; dwReceiveDataLength : DWORD -> "sptr"
; dwLocalAddressLength : DWORD -> "sptr"
; dwRemoteAddressLength : DWORD -> "sptr"
; LocalSockaddr : SOCKADDR** out -> "sptr"
; LocalSockaddrLength : INT* out -> "sptr"
; RemoteSockaddr : SOCKADDR** out -> "sptr"
; RemoteSockaddrLength : INT* out -> "sptr"

出力引数:

#uselib "MSWSOCK.dll"
#func global GetAcceptExSockaddrs "GetAcceptExSockaddrs" sptr, int, int, int, var, var, var, var
; GetAcceptExSockaddrs lpOutputBuffer, dwReceiveDataLength, dwLocalAddressLength, dwRemoteAddressLength, LocalSockaddr, LocalSockaddrLength, RemoteSockaddr, RemoteSockaddrLength
; lpOutputBuffer : void* -> "sptr"
; dwReceiveDataLength : DWORD -> "int"
; dwLocalAddressLength : DWORD -> "int"
; dwRemoteAddressLength : DWORD -> "int"
; LocalSockaddr : SOCKADDR** out -> "var"
; LocalSockaddrLength : INT* out -> "var"
; RemoteSockaddr : SOCKADDR** out -> "var"
; RemoteSockaddrLength : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSWSOCK.dll"
#func global GetAcceptExSockaddrs "GetAcceptExSockaddrs" sptr, int, int, int, sptr, sptr, sptr, sptr
; GetAcceptExSockaddrs lpOutputBuffer, dwReceiveDataLength, dwLocalAddressLength, dwRemoteAddressLength, varptr(LocalSockaddr), varptr(LocalSockaddrLength), varptr(RemoteSockaddr), varptr(RemoteSockaddrLength)
; lpOutputBuffer : void* -> "sptr"
; dwReceiveDataLength : DWORD -> "int"
; dwLocalAddressLength : DWORD -> "int"
; dwRemoteAddressLength : DWORD -> "int"
; LocalSockaddr : SOCKADDR** out -> "sptr"
; LocalSockaddrLength : INT* out -> "sptr"
; RemoteSockaddr : SOCKADDR** out -> "sptr"
; RemoteSockaddrLength : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。