DhcpEnumSubnetClientsV6 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumSubnetClientsV6 函式會傳回指定子網中具有服務 IP 位址的用戶端列舉清單。

語法

DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsV6(
  [in]      DHCP_CONST WCHAR            *ServerIpAddress,
  [in]      DHCP_IPV6_ADDRESS           SubnetAddress,
  [in, out] DHCP_RESUME_IPV6_HANDLE     *ResumeHandle,
  [in]      DWORD                       PreferredMaximum,
  [out]     LPDHCP_CLIENT_INFO_ARRAY_V6 *ClientInfo,
  [out]     DWORD                       *ClientsRead,
  [out]     DWORD                       *ClientsTotal
);

參數

[in] ServerIpAddress

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

[in] SubnetAddress

DHCP_IPV6_ADDRESS 值，其中包含子網閘道的IP位址。

[in, out] ResumeHandle

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

[in] PreferredMaximum

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

[out] ClientInfo

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

[out] ClientsRead

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

[out] ClientsTotal

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