Dhcpv6ReleasePrefix function (dhcpv6csdk.h)

Article
10/13/2021

The Dhcpv6ReleasePrefix function releases a prefix previously acquired with the Dhcpv6RequestPrefix function.

Syntax

DWORD Dhcpv6ReleasePrefix(
  [in] LPWSTR                         adapterName,
  [in] LPDHCPV6CAPI_CLASSID           classId,
  [in] LPDHCPV6PrefixLeaseInformation leaseInfo
);

Parameters

[in] adapterName

Name of the adapter on which the PD request must be sent.

[in] classId

Pointer to a DHCPV6CAPI_CLASSID structure that contains the binary ClassId information to use to send on the wire.

Note DHCPv6 Option Code 15 (0x000F) is not supported by this API. Typically, the User Class option is used by a client to identify the type or category of user or application it represents. A server selects the configuration information for the client based on the classes identified in this option.

[in] leaseInfo

Pointer to a DHCPV6CAPIPrefixLeaseInformation structure that is used to release the prefix.

Return value

Returns ERROR_SUCCESS upon successful completion.

Return code	Description
ERROR_INVALID_PARAMETER	Returned if one of the following conditions are true: AdapterName is NULL. Or no adapter is found with the GUID specified. prefixleaseInfo is NULL.
ERROR_INVALID_NAME	The AdapterName is not in the correct format. It should be in this format: {00000000-0000-0000-0000-000000000000}.

Remarks

Release messages sent as the result of the call to this function must contain the following values for the T1 and T2 fields of the DHCPV6CAPIPrefixLeaseInformation structure supplied in the prefixleaseInfo parameter:

T1: the renewal time for the prefix, in seconds specified as absolute time values.
T2: the rebind time of the prefix, in seconds specified as absolute time values.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	dhcpv6csdk.h
Library	Dhcpcsvc6.lib
DLL	Dhcpcsvc6.dll

Share via