3.2.4.82 R_DhcpGetMibInfoV5 (Opnum 81)

  • Article

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

 DWORD R_DhcpGetMibInfoV5(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [out] LPDHCP_MIB_INFO_V5* 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_V5 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 81.

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, then return error ERROR_ACCESS_DENIED.

  • Allocate memory for MibInfo equal to the size of the DHCP_MIB_INFO_V5 structure.

  • Retrieve all the statistics stored in the server ADM element DHCPv4ServerMibInfo and copy them to the corresponding fields of MibInfo.

  • Retrieve the DHCPv4ScopesList object and set Scopes to the number of entries in it.

  • Allocate memory for ScopeInfo field equal to the number of Subnets multiplied by the size of the SCOPE_MIB_INFO_V5 structure.

  • Incrementally calculate the statistics for all the DHCPv4Scope objects in DHCPv4ScopesList using the information in DHCPv4Scope and copy them to the ScopeInfo structure referenced by MibInfo, and return ERROR_SUCCESS.

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