dhcpEnumSubnetClients 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumSubnetClients函式會傳回列舉清單，其中包含指定子網中提供之 IP 位址的用戶端清單。

語法

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

參數

[in] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS 包含子網識別碼的值。 如需子網識別碼的詳細資訊 ，請參閱 RFC 950 。

[in, out] ResumeHandle

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

[in] PreferredMaximum

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

最小值為 1024 個位元組 (1KB) ，最大值為 65536 個位元組， (64KB) ;如果輸入值大於或小於此範圍，則會分別設定為最大值或最小值。

[out] ClientInfo

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

[out] ClientsRead

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

[out] ClientsTotal

DWORD值的指標，指定尚未列舉之指定子網的用戶端數目。

注意 此值會在最終列舉呼叫期間設定為正確的值;不過，在呼叫此函式之前，請將值設定為 「0x7FFFFFFF」。
 

傳回值

此函式會在成功呼叫時 傳回ERROR_MORE_DATA 。 最後一組子網用戶端對這個方法的呼叫會 傳回ERROR_SUCCESS。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

備註

此函式需要參數結構中所有 DHCP_IP_ADDRESS 值的主機位元組順序。

需求

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

另請參閱

DHCP_CLIENT_INFO_ARRAY