dhcpEnumClasses 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumClasses函式會列舉為 DHCP 伺服器設定的使用者或廠商類別。

語法

DWORD DhcpEnumClasses(
  [in]      LPWSTR                  ServerIpAddress,
  [in]      DWORD                   ReservedMustBeZero,
  [in, out] DHCP_RESUME_HANDLE      *ResumeHandle,
  [in]      DWORD                   PreferredMaximum,
  [out]     LPDHCP_CLASS_INFO_ARRAY *ClassInfoArray,
  [out]     DWORD                   *nRead,
  [out]     DWORD                   *nTotal
);

參數

[in] ServerIpAddress

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

[in] ReservedMustBeZero

保留的。 此欄位必須設定為零。

[in, out] ResumeHandle

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

[in] PreferredMaximum

指定要傳回的慣用類別數目上限。 如果剩餘未分類類別的數目小於此值，則會傳回該數量。 若要擷取 DHCP 伺服器上可用的所有類別，請將此參數設定為 0xFFFFFFFF。

[out] ClassInfoArray

包含傳回類別 之DHCP_CLASS_INFO_ARRAY 結構的指標。 如果 DHCP 伺服器上沒有可用的類別，此參數會傳回 null。

[out] nRead

DWORD 值的指標，指定 ClassInfoArray中傳回的類別數目。

[out] nTotal

DWORD 值的指標，指定儲存在 DHCP 伺服器上的類別總數。

傳回值

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

傳回碼 描述
ERROR_ACCESS_DENIED
 此呼叫是由不是「DHCP 系統管理員」安全性群組成員的用戶端所執行。
ERROR_DHCP_JET_ERROR
 存取 DHCP 伺服器的資料庫時發生錯誤。

需求

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

另請參閱

DHCP_CLASS_INFO_ARRAY

DhcpCreateClass

DhcpDeleteClass