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

WSAAddressToStringW

関数
ソケットアドレス構造体を文字列表現へ変換する。
DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

INT WSAAddressToStringW(
    SOCKADDR* lpsaAddress,
    DWORD dwAddressLength,
    WSAPROTOCOL_INFOW* lpProtocolInfo,   // optional
    LPWSTR lpszAddressString,
    DWORD* lpdwAddressStringLength
);

パラメーター

名前方向
lpsaAddressSOCKADDR*in
dwAddressLengthDWORDin
lpProtocolInfoWSAPROTOCOL_INFOW*inoptional
lpszAddressStringLPWSTRout
lpdwAddressStringLengthDWORD*inout

戻り値の型: INT

各言語での呼び出し定義

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

INT WSAAddressToStringW(
    SOCKADDR* lpsaAddress,
    DWORD dwAddressLength,
    WSAPROTOCOL_INFOW* lpProtocolInfo,   // optional
    LPWSTR lpszAddressString,
    DWORD* lpdwAddressStringLength
);
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSAAddressToStringW(
    IntPtr lpsaAddress,   // SOCKADDR*
    uint dwAddressLength,   // DWORD
    IntPtr lpProtocolInfo,   // WSAPROTOCOL_INFOW* optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszAddressString,   // LPWSTR out
    ref uint lpdwAddressStringLength   // DWORD* in/out
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAAddressToStringW(
    lpsaAddress As IntPtr,   ' SOCKADDR*
    dwAddressLength As UInteger,   ' DWORD
    lpProtocolInfo As IntPtr,   ' WSAPROTOCOL_INFOW* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszAddressString As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpdwAddressStringLength As UInteger   ' DWORD* in/out
) As Integer
End Function
' lpsaAddress : SOCKADDR*
' dwAddressLength : DWORD
' lpProtocolInfo : WSAPROTOCOL_INFOW* optional
' lpszAddressString : LPWSTR out
' lpdwAddressStringLength : DWORD* in/out
Declare PtrSafe Function WSAAddressToStringW Lib "ws2_32" ( _
    ByVal lpsaAddress As LongPtr, _
    ByVal dwAddressLength As Long, _
    ByVal lpProtocolInfo As LongPtr, _
    ByVal lpszAddressString As LongPtr, _
    ByRef lpdwAddressStringLength As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAAddressToStringW = ctypes.windll.ws2_32.WSAAddressToStringW
WSAAddressToStringW.restype = ctypes.c_int
WSAAddressToStringW.argtypes = [
    ctypes.c_void_p,  # lpsaAddress : SOCKADDR*
    wintypes.DWORD,  # dwAddressLength : DWORD
    ctypes.c_void_p,  # lpProtocolInfo : WSAPROTOCOL_INFOW* optional
    wintypes.LPWSTR,  # lpszAddressString : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpdwAddressStringLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAAddressToStringW = Fiddle::Function.new(
  lib['WSAAddressToStringW'],
  [
    Fiddle::TYPE_VOIDP,  # lpsaAddress : SOCKADDR*
    -Fiddle::TYPE_INT,  # dwAddressLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpProtocolInfo : WSAPROTOCOL_INFOW* optional
    Fiddle::TYPE_VOIDP,  # lpszAddressString : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpdwAddressStringLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ws2_32")]
extern "system" {
    fn WSAAddressToStringW(
        lpsaAddress: *mut SOCKADDR,  // SOCKADDR*
        dwAddressLength: u32,  // DWORD
        lpProtocolInfo: *mut WSAPROTOCOL_INFOW,  // WSAPROTOCOL_INFOW* optional
        lpszAddressString: *mut u16,  // LPWSTR out
        lpdwAddressStringLength: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int WSAAddressToStringW(IntPtr lpsaAddress, uint dwAddressLength, IntPtr lpProtocolInfo, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszAddressString, ref uint lpdwAddressStringLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAAddressToStringW' -Namespace Win32 -PassThru
# $api::WSAAddressToStringW(lpsaAddress, dwAddressLength, lpProtocolInfo, lpszAddressString, lpdwAddressStringLength)
#uselib "WS2_32.dll"
#func global WSAAddressToStringW "WSAAddressToStringW" wptr, wptr, wptr, wptr, wptr
; WSAAddressToStringW varptr(lpsaAddress), dwAddressLength, varptr(lpProtocolInfo), varptr(lpszAddressString), varptr(lpdwAddressStringLength)   ; 戻り値は stat
; lpsaAddress : SOCKADDR* -> "wptr"
; dwAddressLength : DWORD -> "wptr"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "wptr"
; lpszAddressString : LPWSTR out -> "wptr"
; lpdwAddressStringLength : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global WSAAddressToStringW "WSAAddressToStringW" var, int, var, var, var
; res = WSAAddressToStringW(lpsaAddress, dwAddressLength, lpProtocolInfo, lpszAddressString, lpdwAddressStringLength)
; lpsaAddress : SOCKADDR* -> "var"
; dwAddressLength : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "var"
; lpszAddressString : LPWSTR out -> "var"
; lpdwAddressStringLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSAAddressToStringW(SOCKADDR* lpsaAddress, DWORD dwAddressLength, WSAPROTOCOL_INFOW* lpProtocolInfo, LPWSTR lpszAddressString, DWORD* lpdwAddressStringLength)
#uselib "WS2_32.dll"
#cfunc global WSAAddressToStringW "WSAAddressToStringW" var, int, var, var, var
; res = WSAAddressToStringW(lpsaAddress, dwAddressLength, lpProtocolInfo, lpszAddressString, lpdwAddressStringLength)
; lpsaAddress : SOCKADDR* -> "var"
; dwAddressLength : DWORD -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "var"
; lpszAddressString : LPWSTR out -> "var"
; lpdwAddressStringLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAAddressToStringW = ws2_32.NewProc("WSAAddressToStringW")
)

// lpsaAddress (SOCKADDR*), dwAddressLength (DWORD), lpProtocolInfo (WSAPROTOCOL_INFOW* optional), lpszAddressString (LPWSTR out), lpdwAddressStringLength (DWORD* in/out)
r1, _, err := procWSAAddressToStringW.Call(
	uintptr(lpsaAddress),
	uintptr(dwAddressLength),
	uintptr(lpProtocolInfo),
	uintptr(lpszAddressString),
	uintptr(lpdwAddressStringLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSAAddressToStringW(
  lpsaAddress: Pointer;   // SOCKADDR*
  dwAddressLength: DWORD;   // DWORD
  lpProtocolInfo: Pointer;   // WSAPROTOCOL_INFOW* optional
  lpszAddressString: PWideChar;   // LPWSTR out
  lpdwAddressStringLength: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAAddressToStringW';
result := DllCall("WS2_32\WSAAddressToStringW"
    , "Ptr", lpsaAddress   ; SOCKADDR*
    , "UInt", dwAddressLength   ; DWORD
    , "Ptr", lpProtocolInfo   ; WSAPROTOCOL_INFOW* optional
    , "Ptr", lpszAddressString   ; LPWSTR out
    , "Ptr", lpdwAddressStringLength   ; DWORD* in/out
    , "Int")   ; return: INT
●WSAAddressToStringW(lpsaAddress, dwAddressLength, lpProtocolInfo, lpszAddressString, lpdwAddressStringLength) = DLL("WS2_32.dll", "int WSAAddressToStringW(void*, dword, void*, char*, void*)")
# 呼び出し: WSAAddressToStringW(lpsaAddress, dwAddressLength, lpProtocolInfo, lpszAddressString, lpdwAddressStringLength)
# lpsaAddress : SOCKADDR* -> "void*"
# dwAddressLength : DWORD -> "dword"
# lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "void*"
# lpszAddressString : LPWSTR out -> "char*"
# lpdwAddressStringLength : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。