DhcpGetClientInfo function (dhcpsapi.h)

Article
02/22/2024

The DhcpGetClientInfo function returns information about a specific DHCP client.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetClientInfo(
  [in]  DHCP_CONST WCHAR            *ServerIpAddress,
  [in]  DHCP_CONST DHCP_SEARCH_INFO *SearchInfo,
  [out] LPDHCP_CLIENT_INFO          *ClientInfo
);

Parameters

[in] ServerIpAddress

Unicode string that specifies the IP address or hostname of the DHCP server.

[in] SearchInfo

DHCP_SEARCH_INFO structure that contains the parameters for the search.

[out] ClientInfo

Pointer to a DHCP_CLIENT_INFO structure that contains information describing the DHCP client that most closely matches the provided search parameters. If no client is found, this parameter will be null.

Note

The memory for this parameter must be free using DhcpRpcFreeMemory.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Remarks

This function requires host byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	dhcpsapi.h
Library	Dhcpsapi.lib
DLL	Dhcpsapi.dll