ホーム › Networking.WinSock › LPWSPGETPEERNAME

LPWSPGETPEERNAME

コールバック

シグネチャ

INT LPWSPGETPEERNAME(
    SOCKET s,
    SOCKADDR* name,
    INT* namelen,
    INT* lpErrno
);

パラメーター

フィールド	型	説明
s	SOCKET	接続済みのソケットを識別する記述子です。
name	SOCKADDR*	ピアの名前を受け取る sockaddr 構造体へのポインターです。
namelen	INT*	入力時は、name が指す構造体のサイズ (バイト単位) を示す整数へのポインターです。出力時は、返された名前のサイズ (バイト単位) を示します。
lpErrno	INT*	エラーコードへのポインターです。

公式ドキュメント

LPWSPGetPeerName 関数は、ソケットの接続先であるピアのアドレスを取得します。

戻り値

エラーが発生しなかった場合、LPWSPGetPeerName は 0 を返します。それ以外の場合は SOCKET_ERROR が返され、固有のエラーコードが lpErrno に格納されます。

エラーコード	意味
WSAENETDOWN	ネットワークサブシステムが異常終了しました。
WSAEFAULT	name パラメーターまたは namelen パラメーターが、ユーザーアドレス空間の有効な一部ではないか、namelen パラメーターが小さすぎます。
WSAEINPROGRESS	コールバックの実行中に関数が呼び出されました。
WSAENOTSOCK	記述子がソケットではありません。
WSAENOTCONN	ソケットが接続されていません。
WSAENOTSOCK	記述子がソケットではありません。

解説(Remarks)

LPWSPGetPeerName 関数は、ソケット s に接続しているピアの名前を取得し、name が参照する sockaddr 構造体に格納します。この関数は接続済みのソケットに対してのみ使用できます。データグラムソケットの場合、直前の LPWSPConnect 呼び出しで指定されたピアの名前だけが返され、直前の LPWSPSendTo 呼び出しで指定された名前は LPWSPGetPeerName では返されません。

復帰時、namelen パラメーターには、返された名前の実際のサイズ (バイト単位) が格納されます。

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