The Dhcpv6RequestPrefix function requests a specific prefix.

Syntax

DWORD APIENTRY Dhcpv6RequestPrefix(
  __in     LPWSTR adapterName,
  __in     LPDHCPV6CAPI_CLASSID classId,
  __inout  LPDHCPV6PrefixLeaseInformation prefixleaseInfo,
  __out    DWORD pdwTimeToWait
);

Parameters

adapterName [in]

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

classId [in]

Pointer to a DHCPV6CAPI_CLASSID structure that contains the binary ClassId information 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.

prefixleaseInfo [in, out]

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

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

DHCPV6PrefixLeaseInformation member	Consideration
nPrefixes	Must contain a maximum value of 10. The caller should have the memory allocated in the prefixArray member based on the number of prefixes specified.
iaid	A unique positive number assigned to this member. This same value should be reused if this function is called again. This mandatory value must be set by the calling application.
ServerIdLen	Must contain a maximum value of 128. The caller must have the memory allocated in the ServerId member based on the specified ServerIdLen value.

 

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.

pdwTimeToWait [out]

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

Send comments about this topic to Microsoft

Build date: 11/19/2009