Share via

3.2.4.70 R_DhcpGetServerBindingInfoV6 (Opnum 69)

  • Article

The R_DhcpGetServerBindingInfoV6 method retrieves the array of IPv6 interface binding information for the DHCPv6 server. The caller of this function can free the memory pointed to by BindElementsInfo by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetServerBindingInfoV6(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] ULONG Flags,
   [out] LPDHCPV6_BIND_ELEMENT_ARRAY* BindElementsInfo
 );

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

Flags: This flag is not used, and it MUST be set to 0.

BindElementsInfo: This is a pointer of type LPDHCPV6_BIND_ELEMENT_ARRAY that points to the location in which the information about the IPv6 interface binding 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.

The opnum field value for this method is 69.

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

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

  • If Flags is not zero, return ERROR_INVALID_PARAMETER.

  • Allocate memory for BindElementsInfo that is equal to the size of data type DHCPV6_BIND_ELEMENT_ARRAY.

  • Allocate memory for the number of DHCPv6ServerBindingInfo elements in the server ADM element DHCPv6ServerBindingInfoList. Retrieve each DHCPv6ServerBindingInfo object from the server ADM element DHCPv6ServerBindingInfoList, and copy it into BindElementsInfo.

  • Return ERROR_SUCCESS.

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