dhcpEnumSubnetClientsV5 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumSubnetClientsV5 函式會傳回列舉清單，其中包含指定子網中服務 IP 位址的用戶端。 此函式會傳回包含特定用戶端類型的DHCP_CLIENT_INFO_V5結構清單，以擴充 DhcpEnumSubnetClients 函式中提供的功能， (DHCP 和/或 BOOTP) 和 IP 地址狀態。

語法

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

參數

[in] ServerIpAddress

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

[in] SubnetAddress

值，包含子網閘道的IP位址。 如果此參數設定為 0，則會傳回 DHCP 伺服器上定義之所有 IPv4 子網的 DHCP 用戶端。

[in, out] ResumeHandle

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

[in] PreferredMaximum

要傳回之子網用戶端信息結構的慣用位元組數目上限。 如果剩餘未分類的選項數目 (位元組) 小於此值，則會傳回該數量。

[out] ClientInfo

DHCP_CLIENT_INFO_ARRAY_V5 結構的指標，其中包含此特定子網下所提供之客戶端的資訊。 如果沒有可用的用戶端，此欄位將會是 Null。

[out] ClientsRead

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

[out] ClientsTotal

值的指標，指定 DHCP 伺服器上所儲存指定子網的客戶端總數。

傳回值

DhcpEnumSubnetClientsV5 函式會在成功時傳回ERROR_SUCCESS。

發生錯誤時，函式會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

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

備註

當不再需要資訊時，此函式的呼叫端必須釋放在 ClientInfo 參數所指向之緩衝區中傳回之DHCP_CLIENT_INFO_ARRAY_V5結構所使用的記憶體。

規格需求

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

另請參閱

DHCP_CLIENT_INFO_ARRAY_V5

DHCP_IP_ADDRESS

DHCP_RESUME_HANDLE

DhcpEnumSubnetClients