LookupPersistentUdpPortReservation 関数 (iphlpapi.h)

[アーティクル]
02/28/2024

LookupPersistentUdpPortReservation 関数は、ローカルコンピューター上の TCP ポートの連続するブロックの永続的な UDP ポート予約のトークンを検索します。

構文

IPHLPAPI_DLL_LINKAGE ULONG LookupPersistentUdpPortReservation(
  [in]  USHORT   StartPort,
  [in]  USHORT   NumberOfPorts,
  [out] PULONG64 Token
);

パラメーター

[in] StartPort

ネットワークバイト順の開始 UDP ポート番号。

[in] NumberOfPorts

予約された UDP ポート番号の数。

[out] Token

関数が成功した場合に返されるポート予約トークンへのポインター。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

リターンコード	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。 StartPort パラメーターまたは NumberOfPorts パラメーターで 0 が渡された場合、このエラーが返されます。
ERROR_NOT_FOUND	要素が見つかりませんでした。 StartPort パラメーターと NumberOfPorts パラメーターで指定された永続的なポートブロックが見つからなかった場合、このエラーが返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

LookupPersistentUdpPortReservation 関数は、Windows Vista 以降で定義されています。

LookupPersistentUdpPortReservation 関数は、UDP ポートのブロックの永続的な予約のトークンを検索するために使用されます。

UDP ポートのブロックの永続的な予約は、 CreatePersistentUdpPortReservation 関数の呼び出しによって作成されます。 LookupPersistentUdpPortReservation 関数に渡される StartPort または NumberOfPorts パラメーターは、TCP ポートのブロックの永続的な予約が CreatePersistentUdpPortReservation 関数によって作成されたときに使用される値と一致する必要があります。

LookupPersistentUdpPortReservation 関数が成功した場合、返される Token パラメーターは、UDP ポートのブロックの永続的なポート予約のトークンを指します。 TCP ポートのブロックに対する特定の永続的な予約のトークンは、システムが再起動されるたびに変更される可能性があることに注意してください。

アプリケーションは、UDP ソケットを開き、SIO_ASSOCIATE_PORT_RESERVATION IOCTL を指定して WSAIoctl 関数を呼び出し、予約トークンを渡してからソケットのバインド関数の呼び出しを発行することで、UDP ポート予約からポートの割り当てを要求できます。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	iphlpapi.h
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll