Expand Minimize

DhcpGetClientInfoV6 function

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

Syntax


DWORD WINAPI DhcpGetClientInfoV6(
  _In_   DHCP_CONST WCHAR *ServerIpAddress,
  _In_   DHCP_CONST DHCP_SEARCH_INFO_V6 *SearchInfo,
  _Out_  LPDHCP_CLIENT_INFO_V6 *ClientInfo
);

Parameters

ServerIpAddress [in]

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

SearchInfo [in]

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.

ClientInfo [out]

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

ERROR_INVALID_PARAMETER

Either Dhcpc6ClientDuid or Dhcpv6ClientName was specified for the SearchType member of SearchInfo.

 

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft