DhcpEnumOptionsV5 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumOptionsV5函式會傳回指定使用者或廠商類別的 DHCP 選項列舉清單。

語法

DWORD DhcpEnumOptionsV5(
  [in]      LPWSTR              ServerIpAddress,
  [in]      DWORD               Flags,
  [in]      LPWSTR              ClassName,
  [in]      LPWSTR              VendorName,
  [in, out] DHCP_RESUME_HANDLE  *ResumeHandle,
  [in]      DWORD               PreferredMaximum,
  [out]     LPDHCP_OPTION_ARRAY *Options,
  [out]     DWORD               *OptionsRead,
  [out]     DWORD               *OptionsTotal
);

參數

[in] ServerIpAddress

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

[in] Flags

一組旗標，指出列舉的選項定義。

值 意義
0x00000000
 預設廠商類別會列舉選項定義。
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 特定廠商類別會列舉選項定義。

[in] ClassName

Unicode 字串的指標，其中包含將列舉其選項之類別的名稱。 這是選擇性參數。

[in] VendorName

Unicode 字串的指標，其中包含類別的廠商名稱。 這是選擇性參數。 如果未提供廠商類別名稱，則會使用預設廠商類別名稱。

[in, out] ResumeHandle

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

[in] PreferredMaximum

指定要傳回之選項的慣用位元組數目上限。 如果剩餘未列舉的選項定義數目 (位元組) 小於此值，則會傳回所有選項定義。

[out] Options

包含傳回選項定義的 DHCP_OPTION_ARRAY 結構的指標。 如果 DHCP 伺服器上沒有可用的選項定義，此參數會傳回 null。

[out] OptionsRead

DWORD 值的指標，指定 Options中所傳回的選項定義數目。

[out] OptionsTotal

DWORD 值的指標，指定 DHCP 伺服器上未匯總的選項定義總數。

傳回值

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

傳回碼 描述
ERROR_ACCESS_DENIED
 此呼叫是由不是「DHCP 系統管理員」安全性群組成員的用戶端所執行。
ERROR_DHCP_CLASS_NOT_FOUND
 提供的使用者或廠商類別名稱不正確或未知。

需求

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

另請參閱

DHCP_OPTION_ARRAY

DhcpCreateOptionV5

DhcpRemoveOptionV5