dhcpEnumOptionValues 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumOptionValues 函式會傳回選項值的列舉清單， (只傳回指定範圍的選項數據和相關聯的標識碼號碼) 。

語法

DWORD DHCP_API_FUNCTION DhcpEnumOptionValues(
  [in]      DHCP_CONST WCHAR                  *ServerIpAddress,
  [in]      DHCP_CONST DHCP_OPTION_SCOPE_INFO *ScopeInfo,
  [in, out] DHCP_RESUME_HANDLE                *ResumeHandle,
  [in]      DWORD                             PreferredMaximum,
  [out]     LPDHCP_OPTION_VALUE_ARRAY         *OptionValues,
  [out]     DWORD                             *OptionsRead,
  [out]     DWORD                             *OptionsTotal
);

參數

[in] ServerIpAddress

指定 DHCP 伺服器的 IP 位址或主機名的 Unicode 字串。

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO 結構，其中包含明確 (層級：預設、伺服器、範圍或 IPv4 保留層級) ，其中會定義選項值，而且應該列舉。

[in, out] ResumeHandle

識別列舉作業 之DHCP_RESUME_HANDLE 值的指標。 一開始，這個值應該是零，且成功呼叫會傳回用於後續列舉要求的句柄值。 例如，如果 PreferredMaximum 設定為 1000 個字節，而 2000 個字節的選項值儲存在伺服器上，可以在擷取前 1000 個字節之後使用繼續句柄，以便在後續呼叫上取得下一個 1000 個，依此類推。

當此函式傳回ERROR_MORE_DATA時，會指出是否有其他可列舉的數據。 如果 DHCPv4 伺服器上沒有額外的可列舉數據，則會傳回ERROR_NO_MORE_ITEMS。

[in] PreferredMaximum

指定要傳回之選項值慣用的最大位元元數目。 如果剩餘未分類的選項數目 (位元組) 小於此值，則會傳回該數量。

若要擷取指定層級的預設使用者和廠商類別的所有選項值，請將此參數設定為 0xFFFFFFFF。

[out] OptionValues

DHCP_OPTION_VALUE_ARRAY 結構的指標，其中包含針對指定範圍傳回的列舉選項值。 如果 DHCP 伺服器上沒有這個範圍可用的選項值，此參數會傳回 null。

[out] OptionsRead

DWORD 值的指標，指定 OptionValues 中傳回的選項值數目。

[out] OptionsTotal

DWORD 值的指標，指定儲存在 DHCP 伺服器上之此範圍的剩餘選項值總數。

傳回值

此函式會在成功呼叫時 傳回ERROR_SUCCESS 。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

傳回碼 Description
ERROR_DHCP_JET_ERROR
 存取 DHCP 伺服器資料庫時發生錯誤。
ERROR_MORE_DATA
 有更多元素可供列舉。
ERROR_NO_MORE_ITEMS
 沒有其他元素可供列舉。
ERROR_DHCP_SUBNET_NOT_PRESENT
 DHCP 伺服器上沒有指定的 IPv4 子網。
ERROR_DHCP_NOT_RESERVED_CLIENT
 指定的 DHCPv4 用戶端不是 IPv4 保留用戶端。

規格需求

需求 值
最低支援的用戶端 都不支援
最低支援的伺服器 Windows Server 2008 R2 [僅限桌面應用程式]
目標平台 Windows
標頭 dhcpsapi.h
程式庫 Dhcpsapi.lib
Dll Dhcpsapi.dll

另請參閱

DHCP_OPTION_VALUE_ARRAY

DhcpEnumOptionValuesV5