DhcpGetClientInfoV4 function

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

ServerIpAddress [in]

Specifies the IP address of the DHCP server.

SearchInfo [in]

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

ClientInfo [out]

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 codeDescription
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpGetClientInfo
DhcpSetClientInfo
DHCP_SEARCH_INFO
DHCP_CLIENT_INFO_V4

 

 

Show: