Dhcpv6RequestPrefix function (dhcpv6csdk.h)

The Dhcpv6RequestPrefix function requests a specific prefix.

Syntax

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

Parameters

[in] adapterName

GUID of the adapter on which the prefix request 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 optional.

[in, out] prefixleaseInfo

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

The following members of the DHCPV6PrefixLeaseInformation structure must follow these guidelines.

The caller must follow these considerations when assigning the values of the nPrefixes, iaid, and ServerIdLen members of the DHCPV6PrefixLeaseInformation structure. Based on these values, memory must also be properly allocated to the ServerId and PrefixArray members before the Dhcpv6RequestPrefix function is called.

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

Return value

Returns ERROR_SUCCESS upon successful completion.

Requirements