Edit

DhcpGetClientInfoV4 function (dhcpsapi.h)

  • Article

The DhcpGetClientInfoV4 function returns information on a specific DHCP client. This function extends DhcpGetClientInfo by returning a DHCP_CLIENT_INFO_V4 structure that contains client type information.

Syntax

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

Parameters

[in] ServerIpAddress

Specifies the IP address of the DHCP server.

[in] SearchInfo

DHCP_SEARCH_INFO structure that contains the search parameters used to select a specific DHCP client.

[out] ClientInfo

DHCP_CLIENT_INFO_V4 structure that contains information that describes the DHCP client that most closely matches the provided search parameters. If no client could be 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.

Return code Description
ERROR_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server's database.

Requirements

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

See also

DHCP_CLIENT_INFO_V4

DHCP_SEARCH_INFO

DhcpGetClientInfo

DhcpSetClientInfo