ホーム › Networking.WinSock › LPWPUQUERYSOCKETHANDLECONTEXT

LPWPUQUERYSOCKETHANDLECONTEXT

コールバック

シグネチャ

INT LPWPUQUERYSOCKETHANDLECONTEXT(
    SOCKET s,
    UINT_PTR* lpContext,
    INT* lpErrno
);

パラメーター

フィールド	型	説明
s	SOCKET	コンテキストを照会する対象のソケットを識別する記述子です。
lpContext	UINT_PTR*	コンテキスト値を受け取るポインターです。
lpErrno	INT*	エラーコードへのポインターです。

公式ドキュメント

WPUQuerySocketHandleContext 関数は、指定されたソケットハンドルに関連付けられたコンテキスト値を照会します。

戻り値

エラーが発生しない場合、 WPUQuerySocketHandleContext はゼロを返し、現在のコンテキスト値を lpContext に格納します。それ以外の場合は SOCKET_ERROR を返し、具体的なエラーコードは lpErrno で取得できます。

エラーコード	意味
WSAENOTSOCK	この記述子は WPUCreateSocketHandle によって作成されたソケットではありません。

解説(Remarks)

WPUQuerySocketHandleContext 関数は、指定されたソケットハンドルに関連付けられた現在のコンテキスト値を照会します。サービスプロバイダーは通常、この関数を使用して、ソケットに関連付けられたプロバイダー固有のデータへのポインターを取得します。たとえばサービスプロバイダーは、ソケットの状態、ローカルおよびリモートのトランスポートアドレス、ネットワークイベントを通知するためのイベントオブジェクトを含む構造体へのポインターを、ソケットコンテキストに格納できます。

IFS プロバイダーはコンテキスト値を提供できないため、この関数を使用するのは非 IFS プロバイダーのみです。

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