DhcpV4GetClientInfo 函式 (dhcpsapi.h)

  • 發行項

DhcpV4GetClientInfo 函式會從 DHCP 伺服器資料庫擷取 DHCP 用戶端租用記錄資訊。

語法

DWORD DHCP_API_FUNCTION DhcpV4GetClientInfo(
  [in, optional] DHCP_CONST WCHAR            *ServerIpAddress,
  [in]           DHCP_CONST DHCP_SEARCH_INFO *SearchInfo,
  [out]          LPDHCP_CLIENT_INFO_PB       *ClientInfo
);

參數

[in, optional] ServerIpAddress

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

[in] SearchInfo

DHCP_SEARCH_INFO 結構的指標，定義用來搜尋 DHCP 伺服器上用戶端租用記錄的索引鍵。

[out] ClientInfo

傳回 DHCP 用戶端租用記錄資訊的 DHCP_CLIENT_INFO_PB 結構的指標。

傳回值

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

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

值 意義
ERROR_INVALID_PARAMETER
 無效或 NULL SearchInfo 已傳遞至函式。
ERROR_ACCESS_DENIED
 此呼叫是由不是 DHCP 使用者 或 DHCP 系統管理員 安全組成員的用戶端所執行。
ERROR_DHCP_INVALID_DHCP_CLIENT
 DHCP 用戶端無效。 在此情況下，傳遞的搜尋信息沒有對應的 IPv4 租用記錄。

備註

如果傳遞至 SearchInfo 之結構的 SearchType 成員是 DhcpClientName，而且有多個具有相同用戶端主機名的租用記錄，則傳回的租用記錄不確定。

ClientInfo 應該使用 DhcpRpcFreeMemory 免費。

規格需求

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

另請參閱

DhcpV4CreateClientInfo

DhcpV4GetClientInfo

DhcpV6CreateClientInfo