LookupPersistentUdpPortReservation 函式 (iphlpapi.h)

發行項
03/13/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。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

傳回碼	Description
ERROR_INVALID_PARAMETER	無效的參數已傳遞至函式。如果在 StartPort 或 NumberOfPorts 參數中傳遞零，則會傳回此錯誤。
ERROR_NOT_FOUND	找不到元素。如果找不到 StartPort 和 NumberOfPorts 參數所指定的持續性埠區塊，就會傳回此錯誤。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

LookupPersistentUdpPortReservation 函式是在 Windows Vista 和更新版本上定義。

LookupPersistentUdpPortReservation 函式可用來查閱 UDP 埠區塊的永續性保留令牌。

UDP 埠區塊的持續保留是透過呼叫 CreatePersistentUdpPortReservation 函式所建立。傳遞至 LookupPersistentUdpPortReservation 函式的 StartPort 或 NumberOfPorts 參數必須符合 CreatePersistentUdpPortReservation 函式建立 TCP 連接埠區塊的持續性保留時所使用的值。

如果 LookupPersistentUdpPortReservation 函式成功，傳回的 Token 參數會指向 UDP 埠區塊之永續性埠保留的令牌。請注意，每次重新啟動系統時，TCP 埠區塊的指定永續性保留令牌可能會變更。

應用程式可以藉由開啟 UDP 套接字來要求來自 UDP 埠保留的埠指派，然後呼叫 WSAIoctl 函式來指定SIO_ASSOCIATE_PORT_RESERVATION IOCTL 並傳遞保留令牌，再對套接字上的 bind 函式發出呼叫。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	iphlpapi.h
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll