Edit

Share via

DhcpDeleteClientInfoV6 function (dhcpsapi.h)

  • Article

The DhcpDeleteClientInfoV6 function deletes the specified DHCPv6 client address release record from the DHCPv6 server database.

Syntax

DWORD DHCP_API_FUNCTION DhcpDeleteClientInfoV6(
  [in] DHCP_CONST WCHAR               *ServerIpAddress,
  [in] DHCP_CONST DHCP_SEARCH_INFO_V6 *ClientInfo
);

Parameters

[in] ServerIpAddress

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

[in] ClientInfo

Pointer to a DHCP_SEARCH_INFO_V6 structure that contains the key used to search for the DHCPv6 client lease record that will be deleted.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes. Commonly returned error codes include:

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_DHCP_RESERVEDIP_EXISTS
 The specified client lease is a reservation.
ERROR_INVALID_PARAMETER
 The SearchType member of DHCP_SEARCH_INFO_V6 was not set to Dhcpv6ClientIpAddress.

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_SEARCH_INFO_V6