ホーム › Networking.WinSock › WSAStringToAddressW

WSAStringToAddressW

関数

文字列形式のアドレスをソケットアドレス構造体へ変換する。

DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSAStringToAddressW(
    LPWSTR AddressString,
    INT AddressFamily,
    WSAPROTOCOL_INFOW* lpProtocolInfo,   // optional
    SOCKADDR* lpAddress,
    INT* lpAddressLength
);

パラメーター

名前	型	方向	説明
AddressString	LPWSTR	in	変換対象となる、標準テキスト形式のネットワークアドレスを含む、ゼロ終端文字列へのポインター。
AddressFamily	INT	in	AddressString パラメーターが指すネットワークアドレスのアドレスファミリー。
lpProtocolInfo	WSAPROTOCOL_INFOW*	inoptional	使用するプロバイダーに関連付けられた WSAPROTOCOL_INFO 構造体。これが NULL の場合、呼び出しは指定された AddressFamily をサポートする最初のプロトコルのプロバイダーへルーティングされます。
lpAddress	SOCKADDR*	out	関数が成功した場合に、アドレス文字列に対応する sockaddr 構造体が格納されるバッファーへのポインター。
lpAddressLength	INT*	inout	lpAddress パラメーターが指すバッファーの長さ(バイト単位)へのポインター。関数呼び出しが成功した場合、このパラメーターは lpAddress パラメーターで返される sockaddr 構造体のサイズへのポインターを返します。指定したバッファーが十分な大きさでない場合、関数は WSAEFAULT という特定のエラーで失敗し、このパラメーターには必要なサイズ(バイト単位)が設定されます。

戻り値の型: INT

公式ドキュメント

WSAStringToAddress 関数は、ネットワークアドレスを標準的なテキスト表現形式から、そのような構造体を受け取る Windows Sockets ルーチンへの受け渡しに適した sockaddr 構造体内の数値バイナリ形式に変換します。(Unicode)

戻り値

WSAStringToAddress の戻り値は、操作が成功した場合はゼロです。それ以外の場合は SOCKET_ERROR が返され、特定のエラー番号は WSAGetLastError を呼び出すことで取得できます。

エラーコード	意味
WSAEFAULT	lpAddress パラメーターが指すバッファーが小さすぎます。より大きなバッファーを渡してください。
WSAEINVAL	関数が文字列を sockaddr に変換できませんでした。詳細については、以下の「解説」セクションを参照してください。
WSANOTINITIALISED	WS2_32.DLL が初期化されていません。アプリケーションは、いずれかの Windows Socket 関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。
WSA_NOT_ENOUGH_MEMORY	操作を実行するためのメモリが不足していました。

解説(Remarks)

WSAStringToAddress 関数は、標準テキスト形式のネットワークアドレスを、sockaddr 構造体内の数値バイナリ形式に変換します。

アドレスに不足している構成要素がある場合、可能であれば妥当な値が既定値として設定されます。たとえば、ポート番号が省略されている場合は既定でゼロになります。呼び出し元が特定のプロバイダーによる変換を希望する場合は、lpProtocolInfo パラメーターに対応する WSAPROTOCOL_INFO 構造体を指定する必要があります。

sockaddr 構造体の形式で lpAddress パラメーターに渡される SOCKADDR_IN 構造体の sin_family メンバーが AF_INET または AF_INET6 に設定されていない場合、 WSAStringToAddress 関数は失敗します(WSAEINVAL を返します)。

WSAStringToAddress 関数による IPv6 アドレスのサポートは、Windows XP with Service Pack 1 (SP1) 以降で追加されました。また、WSAStringToAddress 関数が IPv6 アドレスをサポートするには、ローカルコンピューターに IPv6 がインストールされている必要があります。

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

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

メモ

winsock2.h ヘッダーは WSAStringToAddress を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

INT WSAStringToAddressW(
    LPWSTR AddressString,
    INT AddressFamily,
    WSAPROTOCOL_INFOW* lpProtocolInfo,   // optional
    SOCKADDR* lpAddress,
    INT* lpAddressLength
);

[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int WSAStringToAddressW(
    [MarshalAs(UnmanagedType.LPWStr)] string AddressString,   // LPWSTR
    int AddressFamily,   // INT
    IntPtr lpProtocolInfo,   // WSAPROTOCOL_INFOW* optional
    IntPtr lpAddress,   // SOCKADDR* out
    ref int lpAddressLength   // INT* in/out
);

<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAStringToAddressW(
    <MarshalAs(UnmanagedType.LPWStr)> AddressString As String,   ' LPWSTR
    AddressFamily As Integer,   ' INT
    lpProtocolInfo As IntPtr,   ' WSAPROTOCOL_INFOW* optional
    lpAddress As IntPtr,   ' SOCKADDR* out
    ByRef lpAddressLength As Integer   ' INT* in/out
) As Integer
End Function

' AddressString : LPWSTR
' AddressFamily : INT
' lpProtocolInfo : WSAPROTOCOL_INFOW* optional
' lpAddress : SOCKADDR* out
' lpAddressLength : INT* in/out
Declare PtrSafe Function WSAStringToAddressW Lib "ws2_32" ( _
    ByVal AddressString As LongPtr, _
    ByVal AddressFamily As Long, _
    ByVal lpProtocolInfo As LongPtr, _
    ByVal lpAddress As LongPtr, _
    ByRef lpAddressLength 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

WSAStringToAddressW = ctypes.windll.ws2_32.WSAStringToAddressW
WSAStringToAddressW.restype = ctypes.c_int
WSAStringToAddressW.argtypes = [
    wintypes.LPCWSTR,  # AddressString : LPWSTR
    ctypes.c_int,  # AddressFamily : INT
    ctypes.c_void_p,  # lpProtocolInfo : WSAPROTOCOL_INFOW* optional
    ctypes.c_void_p,  # lpAddress : SOCKADDR* out
    ctypes.POINTER(ctypes.c_int),  # lpAddressLength : INT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAStringToAddressW = Fiddle::Function.new(
  lib['WSAStringToAddressW'],
  [
    Fiddle::TYPE_VOIDP,  # AddressString : LPWSTR
    Fiddle::TYPE_INT,  # AddressFamily : INT
    Fiddle::TYPE_VOIDP,  # lpProtocolInfo : WSAPROTOCOL_INFOW* optional
    Fiddle::TYPE_VOIDP,  # lpAddress : SOCKADDR* out
    Fiddle::TYPE_VOIDP,  # lpAddressLength : INT* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ws2_32")]
extern "system" {
    fn WSAStringToAddressW(
        AddressString: *mut u16,  // LPWSTR
        AddressFamily: i32,  // INT
        lpProtocolInfo: *mut WSAPROTOCOL_INFOW,  // WSAPROTOCOL_INFOW* optional
        lpAddress: *mut SOCKADDR,  // SOCKADDR* out
        lpAddressLength: *mut i32  // INT* 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 WSAStringToAddressW([MarshalAs(UnmanagedType.LPWStr)] string AddressString, int AddressFamily, IntPtr lpProtocolInfo, IntPtr lpAddress, ref int lpAddressLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAStringToAddressW' -Namespace Win32 -PassThru
# $api::WSAStringToAddressW(AddressString, AddressFamily, lpProtocolInfo, lpAddress, lpAddressLength)

#uselib "WS2_32.dll"
#func global WSAStringToAddressW "WSAStringToAddressW" wptr, wptr, wptr, wptr, wptr
; WSAStringToAddressW AddressString, AddressFamily, varptr(lpProtocolInfo), varptr(lpAddress), varptr(lpAddressLength)   ; 戻り値は stat
; AddressString : LPWSTR -> "wptr"
; AddressFamily : INT -> "wptr"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "wptr"
; lpAddress : SOCKADDR* out -> "wptr"
; lpAddressLength : INT* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSAStringToAddressW "WSAStringToAddressW" wstr, int, var, var, var
; res = WSAStringToAddressW(AddressString, AddressFamily, lpProtocolInfo, lpAddress, lpAddressLength)
; AddressString : LPWSTR -> "wstr"
; AddressFamily : INT -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "var"
; lpAddress : SOCKADDR* out -> "var"
; lpAddressLength : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAStringToAddressW "WSAStringToAddressW" wstr, int, sptr, sptr, sptr
; res = WSAStringToAddressW(AddressString, AddressFamily, varptr(lpProtocolInfo), varptr(lpAddress), varptr(lpAddressLength))
; AddressString : LPWSTR -> "wstr"
; AddressFamily : INT -> "int"
; lpProtocolInfo : WSAPROTOCOL_INFOW* optional -> "sptr"
; lpAddress : SOCKADDR* out -> "sptr"
; lpAddressLength : INT* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。