PFN_WSK_GET_LOCAL_ADDRESS コールバック関数 (wsk.h)

[アーティクル]
08/08/2023

WskGetLocalAddress 関数は、ソケットのローカルトランスポートアドレスを取得します。

構文

PFN_WSK_GET_LOCAL_ADDRESS PfnWskGetLocalAddress;

NTSTATUS PfnWskGetLocalAddress(
  [in]      PWSK_SOCKET Socket,
  [out]     PSOCKADDR LocalAddress,
  [in, out] PIRP Irp
)
{...}

パラメーター

[in] Socket

クエリ対象のソケットのソケットオブジェクトを指定する WSK_SOCKET 構造体へのポインター。

[out] LocalAddress

ソケットのローカルトランスポートアドレスを受け取る呼び出し元によって割り当てられたバッファーへのポインター。バッファーは、非ページメモリに配置する必要があります。また、バッファーは、WSK アプリケーションがソケットの作成時に指定したアドレスファミリに対応する特定の SOCKADDR 構造体型を格納するのに十分な大きさにする必要があります。

WSK アプリケーションがリッスンソケットで受け入れた接続指向ソケットの場合、アドレスファミリは、WSK アプリケーションがリッスンソケットを作成したときに指定したアドレスファミリと同じです。

[in, out] Irp

WSK サブシステムが非同期的に取得操作を完了するために使用する呼び出し元によって割り当てられた IRP へのポインター。 WSK 関数での IRP の使用の詳細については、「 Winsock カーネル関数での IRP の使用」を参照してください。

戻り値

WskGetLocalAddress は、次のいずれかの NTSTATUS コードを返します。

リターンコード	説明
STATUS_SUCCESS	ソケットのローカルトランスポートアドレスが正常に取得されました。 IRP は成功状態で完了します。
STATUS_PENDING	WSK サブシステムは、ソケットのローカルトランスポートアドレスをすぐに取得できませんでした。 WSK サブシステムは、ソケットのローカルトランスポートアドレスを取得した後、IRP を完了します。取得操作の状態は、IRP の IoStatus.Status フィールドに返されます。
STATUS_INVALID_DEVICE_STATE	ソケットがローカルトランスポートアドレスにバインドされていません。 IRP は失敗状態で完了します。
STATUS_FILE_FORCED_CLOSED	ソケットは機能しなくなりました。 IRP は失敗状態で完了します。 WSK アプリケーションは、できるだけ早くソケットを閉じるには、WskCloseSocket 関数を呼び出す必要があります。
その他の状態コード	エラーが発生しました。 IRP は失敗状態で完了します。

注釈

WSK アプリケーションは、ローカルトランスポートアドレスにバインドされているソケットでのみ WskGetLocalAddress 関数を呼び出すことができます。

WSK アプリケーションが WskBind 関数を呼び出すと、リッスン、データグラム、またはストリームソケットがローカルトランスポートアドレスにバインドされます。

接続指向ソケットは、次のいずれかの方法でローカルトランスポートアドレスにバインドされます。

WSK アプリケーションは 、WskBind 関数を呼び出します。
WSK アプリケーションは、 WskSocketConnect 関数を呼び出してソケットを作成、バインド、接続します。
WSK サブシステムは、WSK アプリケーションがリッスンしているソケットで受信接続要求を受け入れると、ソケットをバインドします。

WskGetLocalAddress 関数は、ソケットがローカルワイルドカードアドレスにバインドされたときにトランスポートプロトコルによってソケットに割り当てられた特定のローカルトランスポートアドレスを決定する場合に特に便利です。ローカルワイルドカードアドレスにバインドされた接続指向ソケットの場合、ソケットがリモートトランスポートアドレスに接続されるまで、ローカルトランスポートアドレスがトランスポートプロトコルによってソケットに割り当てられない可能性があります。ローカルトランスポートアドレスがソケットに割り当てられる手順は、トランスポートプロトコルに依存します。 TCP の場合、ポート番号は接続指向ソケットがバインドされるときに割り当てられますが、ソケットが接続されるまで IP アドレスは割り当てされません。

WskGetLocalAddress 関数がSTATUS_PENDINGを返す場合、LocalAddress パラメーターが指すバッファーは、IRP が完了するまで有効なままである必要があります。 WSK アプリケーションが ExAllocateXxx 関数のいずれかを使用してバッファーを割り当てた場合、IRP が完了するまで、対応する ExFreeXxx 関数を使用してメモリを解放することはできません。 WSK アプリケーションがスタックにバッファーを割り当てた場合、IRP が完了するまで WskGetLocalAddress 関数を呼び出す関数からを返すことはできません。

要件

要件	値
サポートされている最小のクライアント	Windows Vista 以降のバージョンの Windows オペレーティングシステムで使用できます。
対象プラットフォーム	ユニバーサル
Header	wsk.h (Wsk.h を含む)
IRQL	<= DISPATCH_LEVEL