DhcpV4EnumSubnetClients 函式 (dhcpsapi.h)

  • 發行項

DhcpV4EnumSubnetClients 函式會列舉從指定的 IPv4 子網服務的所有 DHCP 用戶端記錄。

語法

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

參數

[in, optional] ServerIpAddress

代表 DHCP 伺服器的 IP 位址或主機名的 Null 終止 Unicode 字串指標。

[in] SubnetAddress

DHCP_IP_ADDRESS 結構，其中包含要列舉之 DHCP 用戶端記錄的 IPv4 子網位址。 如果設定為 0，則會傳回所有已知 IPv4 子網的 DHCP 用戶端記錄。

[in, out] ResumeHandle

DHCP_RESUME_HANDLE 結構的指標，可識別此列舉，以供後續呼叫此函式使用。 一開始，此值應該在輸入上為零。 如果成功，則應該將傳回的值用於後續列舉要求。 傳回的句柄值是列舉作業中擷取的最後一個IPv4 位址。

[in] PreferredMaximum

客戶端記錄在 ClientInfo 中傳回的最大位元元組數。 最小值為 1024 個字節，最大值為 65536 個字節。

[out] ClientInfo

DHCP_CLIENT_INFO_PB_ARRAY 結構的指標，其中包含指定子網可用的 DHCP 用戶端租用記錄集。

[out] ClientsRead

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

[out] ClientsTotal

DWORD 的指標，指定尚未列舉之 DHCP 伺服器上客戶端記錄的數目。

傳回值

如果函式成功，它會傳回 ERROR_SUCCESS。

如果函式失敗，它會從 DHCP 伺服器管理 API 錯誤碼傳回下列其中一個錯誤碼或錯誤碼。

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

備註

ClientInfo 應該使用 DhcpRpcFreeMemory 免費。

規格需求

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