DhcpEnumSubnetClientsFilterStatusInfo 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumSubnetClientsFilterStatusInfo 函式會列舉指定子網上服務的所有 DHCP 用戶端，並包含每個用戶端的連結層篩選狀態。

語法

DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsFilterStatusInfo(
  [in]      DHCP_CONST WCHAR                       *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                        SubnetAddress,
  [in, out] DHCP_RESUME_HANDLE                     *ResumeHandle,
  [in]      DWORD                                  PreferredMaximum,
  [out]     LPDHCP_CLIENT_FILTER_STATUS_INFO_ARRAY *ClientInfo,
  [out]     DWORD                                  *ClientsRead,
  [out]     DWORD                                  *ClientsTotal
);

參數

[in] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS 值，其中包含傳回 DHCP 用戶端的 IPv4 子網。 如果此參數設定為 0，則會傳回所有已知 IPv4 子網的 DHCP 用戶端。

[in, out] ResumeHandle

識別 DHCP 伺服器上列舉作業 之DHCP_RESUME_HANDLE 值的指標。 一開始，此值必須設定為 0。 成功的呼叫會傳回此參數中的句柄值，此值可以傳遞至後續的列舉要求。 傳回的句柄值是列舉作業中擷取的最後一個IPv4 位址。

[in] PreferredMaximum

指定要在列舉作業中傳回的慣用位元組數目上限。 最小值為 1024 個字節，最大值為 65536 個字節。

[out] ClientInfo

DHCP_CLIENT_FILTER_STATUS_INFO_ARRAY結構的指標，其中包含指定子網上服務的所有 DHCP 用戶端，以及每個子網上任何相關聯的連結層篩選狀態資訊。

[out] ClientsRead

值的指標，指定 ClientInfo 中傳回的 DHCP 用戶端記錄數目。

[out] ClientsTotal

值的指標，指定剩餘和尚未復原的 DHCP 用戶端記錄數目。 例如，如果給定 IPv4 子網有 100 筆 DHCP 用戶端記錄，而且每個呼叫會列舉 10 筆客戶端記錄，則第一次呼叫此值之後會傳回 90。

傳回值

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

傳回碼 Description
ERROR_ACCESS_DENIED
 此呼叫是由不是「DHCP 系統管理員」安全組成員的用戶端所執行。
ERROR_DHCP_JET_ERROR
 存取 DHCP 伺服器的資料庫時發生錯誤。
ERROR_MORE_DATA
 針對提供的 IPv4 子網，DHCP 伺服器上仍有未驗證的用戶端租用記錄。 請使用傳回的繼續句柄再次呼叫此函式，以取得更多函式。

規格需求

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

另請參閱

DHCP_CLIENT_FILTER_STATUS_INFO_ARRAY