DhcpEnumOptions 函式會傳回一組儲存在 DHCPv4 伺服器上的列舉選項。
語法
DWORD DHCP_API_FUNCTION DhcpEnumOptions(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_OPTION_ARRAY *Options,
[out] DWORD *OptionsRead,
[out] DWORD *OptionsTotal
);
參數
[in] ServerIpAddress
指定 DHCP 伺服器的 IPv4 位址之 Unicode 字串的指標。
[in, out] ResumeHandle
識別列舉作業 之DHCP_RESUME_HANDLE 值的指標。 一開始，這個值應該是零，且成功呼叫會傳回用於後續列舉要求的句柄值。 例如，如果 PreferredMaximum 設定為 1000 個字節，而 2000 個字節的選項會儲存在伺服器上，可以在擷取前 1000 個字節之後使用繼續句柄，以便在後續呼叫時取得下一個 1000 個，依此類推。
當此函式傳回ERROR_MORE_DATA時，會指出是否有其他可列舉的數據。 如果 DHCPv4 伺服器上沒有額外的可列舉數據，則會傳回ERROR_NO_MORE_ITEMS。
[in] PreferredMaximum
指定要傳回之選項的慣用最大位元元數目。 如果剩餘未分類的選項數目 (位元組) 小於此值，則會傳回該數量。
若要擷取預設使用者和廠商類別的所有選項定義，請將此參數設定為 0xFFFFFFFF。
[out] Options
包含傳回選項 之DHCP_OPTION_ARRAY 結構的指標。 如果 DHCPv4 伺服器上沒有可用的選項，此參數會傳回 null。
[out] OptionsRead
DWORD 值的指標，指定 Options 中傳回的選項數目。
[out] OptionsTotal
DWORD 值的指標，指定儲存在 DHCPv4 伺服器上的剩餘選項總數。
傳回值
此函式會在成功呼叫時 傳回ERROR_SUCCESS 。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。
| 傳回碼 | Description |
|---|---|
|
存取 DHCP 伺服器資料庫時發生錯誤。 |
|
有更多元素可供列舉。 |
|
沒有其他元素可供列舉。 |
備註
呼叫完成之後，此函式的呼叫端必須釋放 Options 所指向的記憶體。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | 都不支援 |
| 最低支援的伺服器 | Windows Server 2008 R2 [僅限桌面應用程式] |
| 目標平台 | Windows |
| 標頭 | dhcpsapi.h |
| 程式庫 | Dhcpsapi.lib |
| Dll | Dhcpsapi.dll |