3.1.4.23 R_DhcpGetMibInfo (Opnum 22)

  • Article

The R_DhcpGetMibInfo method is used to retrieve the statistics of the DHCPv4 server. The caller of this function can free the memory pointed to by the MibInfo parameter and its member the ScopeInfo array by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetMibInfo(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [out] LPDHCP_MIB_INFO* MibInfo
 );

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

MibInfo: This is a pointer of type LPDHCP_MIB_INFO that points to the location that contains DHCPv4 server statistics.

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 22.

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

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

  • Retrieve the server Abstract Data Model (ADM) element DHCPv4ServerMibInfo, and copy the information in it to the MibInfo parameter structure.

  • Retrieve the DHCPv4ScopesList ADM element object and set the Scopes member of the MibInfo parameter with the number of entries in it.

  • Incrementally calculate the statistics for all the DHCPv4Scope ADM element objects in the DHCPv4ScopesList ADM element, and copy them to the ScopeInfo member of the MibInfo parameter.

  • Return ERROR_SUCCESS.

Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol specified in [MS-RPCE].