Dhcpv6RenewPrefix function (dhcpv6csdk.h)

  • Article

The Dhcpv6RenewPrefix function renews a prefix previously acquired with the Dhcpv6RequestPrefix function.

Syntax

DWORD Dhcpv6RenewPrefix(
  [in]      LPWSTR                         adapterName,
  [in]      LPDHCPV6CAPI_CLASSID           pclassId,
  [in, out] LPDHCPV6PrefixLeaseInformation prefixleaseInfo,
  [out]     DWORD                          *pdwTimeToWait,
  [in]      DWORD                          bValidatePrefix
);

Parameters

[in] adapterName

GUID of the adapter on which the prefix renewal must be sent.

[in] pclassId

Pointer to a DHCPV6CAPI_CLASSID structure that contains the binary ClassId information to send on the wire. This parameter is can be NULL.

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, out] prefixleaseInfo

Pointer to a DHCPV6PrefixLeaseInformation structure that contains the prefix lease information.

[out] pdwTimeToWait

Contains the number of seconds a requesting application needs to wait before calling the Dhcpv6RenewPrefix function to renew its acquired prefixes. A value of 0xFFFFFFFF indicates that the application does not need to renew its lease.

[in] bValidatePrefix

Specifies to the DHCPv6 client whether or not to send a REBIND in order to validate the prefix bindings. TRUE indicates that a REBIND is required. FALSE indicates RENEW is required.

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.
  • pdwTimeToWait is NULL.
ERROR_MORE_DATA
 Returned if the API responds with more prefixes than there is memory allocated.
ERROR_INVALID_NAME
 The AdapterName is not in the correct format. It should be in this format: {00000000-0000-0000-0000-000000000000}.

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