Share via

3.2.4.32 R_DhcpGetMCastMibInfo (Opnum 31)

  • Article

The R_DhcpGetMCastMibInfo method retrieves the multicast counter values of the MADCAP server. The caller of this function can free the memory pointed to by MibInfo by calling the function midl_user_free (section 3).

 DWORD R_DhcpGetMCastMibInfo(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [out] LPDHCP_MCAST_MIB_INFO* MibInfo
 );

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

MibInfo: This is of type LPDHCP_MCAST_MIB_INFO, pointing to the location that contains the multicast MIB information of the MADCAP server.

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

When processing this call, the MADCAP 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.

  • Retrieve the server ADM element DHCPv4ServerMcastMibInfo and copy the information in it to the MibInfo structure.

  • Set the Scopes field of the MibInfo structure to the number of entries in DHCPv4MScopesList.

  • Incrementally calculate the statistics for all the DHCPv4MScope objects in DHCPv4MScopesList and copy them to the ScopeInfo field of the MibInfo structure.

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