DhcpEnumOptionValuesV6 函式 (dhcpsapi.h)

  • 發行項

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

語法

DWORD DHCP_API_FUNCTION DhcpEnumOptionValuesV6(
  [in]      DHCP_CONST WCHAR          *ServerIpAddress,
  [in]      DWORD                     Flags,
  [in]      LPWSTR                    ClassName,
  [in]      LPWSTR                    VendorName,
  [in]      LPDHCP_OPTION_SCOPE_INFO6 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] Flags

指定位旗標，指出選項是否為廠商特定。 如果不是廠商特定的，則此參數應該是 0。

值 意義
DHCP_FLAGS_OPTION_IS_VENDOR
 如果廠商提供選項，則應該設定此旗標。

[in] ClassName

Unicode 字串，其中包含將列舉其範圍選項值之類別的名稱。

[in] VendorName

Unicode 字串，其中包含類別的廠商名稱。 這是選擇性參數。

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO6 結構，其中包含定義選項值的範圍。

[in, out] ResumeHandle

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

[in] PreferredMaximum

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

[out] OptionValues

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

[out] OptionsRead

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

[out] OptionsTotal

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

傳回值

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

傳回碼 Description
ERROR_INVALID_PARAMETER
 參數無效。
ERROR_NO_MORE_ITEMS
 沒有其他可列舉的項目。
ERROR_NOT_ENOUGH_MEMORY
 記憶體失敗。
ERROR_MORE_DATA
 更多數據可供列舉。

規格需求

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