WSAStringToAddressW

WSAStringToAddress 関数は、標準テキスト表現のネットワークアドレスを sockaddr 構造体の数値バイナリ形式に変換し、同構造体を必要とする Winsock ルーチンに渡せる形で返す。(Unicode)

WSAStringToAddressW AddressString, AddressFamily, lpProtocolInfo, lpAddress, lpAddressLength

AddressString : [wstr] 変換対象となる、標準テキスト形式のネットワークアドレスを含むゼロ終端文字列へのポインタ。
AddressFamily : [int] AddressString が指すネットワークアドレスのアドレスファミリ。
lpProtocolInfo : [var] 使用するプロバイダに関連付けられた WSAPROTOCOL_INFO 構造体。NULL の場合、呼び出しは指定された AddressFamily をサポートする最初のプロトコルのプロバイダにルーティングされる。
lpAddress : [var] 関数が成功した場合に、アドレス文字列に対応する sockaddr 構造体が書き込まれるバッファへのポインタ。
lpAddressLength : [var] lpAddress が指すバッファの長さ (バイト単位) へのポインタ。関数呼び出しが成功すると、lpAddress に返された sockaddr 構造体のサイズを指す値が返される。バッファが小さすぎる場合は WSAEFAULT で失敗し、本引数には必要なサイズ (バイト単位) が設定される。

(プラグイン / モジュール : ws2_32.dll)

解説

WSAStringToAddress 関数は、標準テキスト表現のネットワークアドレスを sockaddr
構造体の数値バイナリ形式に変換し、同構造体を必要とする Winsock ルーチンに渡せる形で返す。(Unicode)

[戻り値]
操作が成功した場合の戻り値はゼロ。そうでない場合は SOCKET_ERROR が返され、WSAGetLastError
で特定のエラー番号を取得できる。
このドキュメントは省略されている。

[備考]
WSAStringToAddress 関数は、標準テキスト形式のネットワークアドレスを sockaddr
構造体の数値バイナリ形式に変換する。不足している要素は可能な限り妥当な既定値で埋める。たとえばポート番号がなければ 0
が既定となる。特定のプロバイダで変換を行いたい場合、lpProtocolInfo に対応する WSAPROTOCOL_INFO
を渡す。WSAStringToAddress は、lpAddress に sockaddr として渡された SOCKADDR_IN の
sin_family メンバが AF_INET または AF_INET6 でない場合に WSAEINVAL
で失敗する。WSAStringToAddress での IPv6 アドレスサポートは Windows XP SP1
以降で追加された。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 ストアアプリでサポートされる。
> [!NOTE] > winsock2.h ヘッダは、UNICODE プリプロセッサ定数の定義に基づいて本関数の ANSI 版と
Unicode 版を自動的に選択するエイリアスとして WSAStringToAddress
を定義している。エンコーディング中立なエイリアスとエンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを招く不整合が発生しうる。詳しくは
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報