3.2.4.64 R_DhcpGetSubnetInfoV6 (Opnum 63)

The R_DhcpGetSubnetInfoV6 method retrieves the information about a specific IPv6 prefix defined on the DHCPv6 server. The caller of this function can free the memory pointed to by SubnetInfo by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetSubnetInfoV6(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] DHCP_IPV6_ADDRESS SubnetAddress,
   [out] LPDHCP_SUBNET_INFO_V6* SubnetInfo
 );

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

SubnetAddress: This is of type DHCP_IPV6_ADDRESS (section 2.2.1.2.28) that contains the IPv6 prefix ID for which the information is retrieved.

SubnetInfo: This is a pointer of type LPDHCP_SUBNET_INFO_V6 in which the information for the subnet matching the ID specified by SubnetAddress is retrieved.

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.

0x00004E25

ERROR_DHCP_SUBNET_NOT_PRESENT

The specified IPv6 prefix does not exist.

The opnum field value for this method is 63.

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 the SubnetInfo parameter is NULL, return ERROR_INVALID_PARAMETER.

  • Retrieve the DHCPv6Scope object from DHDPv6ScopeList whose SubnetAddress field of SubnetInfoV6 is equal to the SubnetAddress passed in as a parameter to the current API.

  • If the DHCPv6Scope object corresponding to SubnetAddress is not found, return ERROR_DHCP_SUBNET_NOT_PRESENT.

  • Copy this DHCPv6Scope object information in SubnetInfo structure, and return it to the caller.

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