Share via

3.2.4.41 R_DhcpGetServerBindingInfo (Opnum 40)

  • Article

The R_DhcpGetServerBindingInfo method retrieves the array of IPv4 interface binding information for the DHCPv4 server. The caller of this function can free the memory pointed by BindElementsInfo by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetServerBindingInfo(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] ULONG Flags,
   [out] LPDHCP_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 LPDHCP_BIND_ELEMENT_ARRAY that points to the location in which the information about the IPv4 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 40.

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 0, return ERROR_INVALID_PARAMETER.

  • Allocate memory to BindElementsInfo which is equal to the size of data type LPDHCP_BIND_ELEMENT_ARRAY. Initialize its members NumElements to zero and Elements to NULL.

  • Retrieve each DHCPv4ServerBindingInfo from the server ADM element DHCPv4ServerBindingInfoList, and copy it into BindElementsInfo.

  • If the server ADM element DHCPv4ServerBindingInfoList has no DHCPv4ServerBindingInfo data, the NumElements field of BindElementsInfo remains at a value of zero and the Elements field remains NULL.

  • Return ERROR_SUCCESS.

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