3.2.4.73 R_DhcpGetClientInfoV6 (Opnum 72)

  • Article

The R_DhcpGetClientInfoV6 method retrieves IPv6 address lease information of the IPv6 reservation from the DHCPv6 server. The caller of this function can free the memory pointed to by ClientInfo by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetClientInfoV6(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in, ref] LPDHCP_SEARCH_INFO_V6 SearchInfo,
   [out] LPDHCP_CLIENT_INFO_V6* ClientInfo
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

SearchInfo: This is a pointer to a structure DHCP_SEARCH_INFO_V6 (section 2.2.1.2.69) that specifies the parameter to be used for retrieving the IPv6 address lease information of IPv6 reservation.

For this call with SearchType of Dhcpv6ClientDUID (section 2.2.1.1.12), ERROR_INVALID_PARAMETER is returned.

For this call SearchType of Dhcpv6ClientName (section 2.2.1.1.12), ERROR_INVALID_PARAMETER is returned.

ClientInfo: This is a pointer to type LPDHCP_CLIENT_INFO_V6 that points to a location in which IPv6 address lease information of IPv6 reservation is retrieved. The caller can free up this buffer after using this.

Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.

Return value/code

Description

0x00000000

ERROR_SUCCESS

The call was successful.

0x00004E2D

ERROR_DHCP_JET_ERROR

An error occurred while accessing the DHCP server database or the client entry is not present in the database.

The opnum field value for this method is 72.

When processing this call, the DHCP server MUST do the following:

  • Validate if this method is authorized for read access per section 3.5.4. If not, return the error ERROR_ACCESS_DENIED.

  • If SearchType is not Dhcpv6ClientIpAddress, return ERROR_INVALID_PARAMETER.

  • Retrieve the information of DHCPv6ClientInfo object from DHCPv6ClientInfoList based on SearchInfo, and return it to the caller.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].