Edit

Share via

DhcpGetClientInfoV6 function (dhcpsapi.h)

  • Article

The DhcpGetClientInfoV6 function retrieves IPv6 address lease information for a specific IPv6 client reservation from the DHCPv6 server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetClientInfoV6(
  [in]  DHCP_CONST WCHAR               *ServerIpAddress,
  [in]  DHCP_CONST DHCP_SEARCH_INFO_V6 *SearchInfo,
  [out] LPDHCP_CLIENT_INFO_V6          *ClientInfo
);

Parameters

[in] ServerIpAddress

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

[in] SearchInfo

Pointer to a DHCP_SEARCH_INFO_V6 structure that contains the search parameters for finding the specific IPv6 lease information for a client. The SearchType member of this structure must be set to Dhcpv6ClientIpAddress.

[out] ClientInfo

Pointer to the address of a DHCP_CLIENT_INFO_V6 structure that contains the IPv6 address lease information that matched the parameters supplied in SearchInfo.

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.
ERROR_INVALID_PARAMETER
 Either Dhcpc6ClientDuid or Dhcpv6ClientName was specified for the SearchType member of SearchInfo.

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