Share via

3.1.4.33 RMIBGetTrapInfo (Opnum 32)

  • Article

The RMIBGetTrapInfo method<299> queries the module that set a trap event for more information about the trap. This method cannot be called remotely.

 DWORD RMIBGetTrapInfo(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD dwPid,
   [in] DWORD dwRoutingPid,
   [in, out] PDIM_MIB_ENTRY_CONTAINER pInfoStruct
 );

hDimServer: A handle to the RRASM server where the call is to be executed, see section 3.1.3.

dwPid: Specifies the transport protocol. The value of this parameter MUST be one from the following table.<300>

Value

Meaning

PID_IPX

0x0000002B

An IPX MIB entry is to be retrieved.

PID_IP

0x00000021

An IPv4 MIB entry is to be retrieved.

PID_IPV6

0x00000057

An IPv6 entry is to be retrieved.

dwRoutingPid: Specifies the routing protocol that exported the variable.

pInfoStruct: Pointer to an opaque data structure DIM_MIB_ENTRY_CONTAINER (section 2.2.1.2.19). The data structure's format is determined by the router manager or router manager client that is servicing the call. The data structure MUST contain information that specifies the variable being created and the value to assign to the variable.  

Return Values: A 32-bit, unsigned integer value that indicates return status. A return value of ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully; otherwise, the value contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values that are not in the table that follows MUST be treated the same by the RRASM client.

Return value/code

Description

ERROR_SUCCESS

0x00000000

The call was successful.

ERROR_ACCESS_DENIED

0x00000005

The calling application does not have sufficient privileges.

The opnum field value for this method is 32.

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

  • Validate, as specified in section 2.1.1.1, whether this method was called by a client that has access to the method. If not, then return error ERROR_ACCESS_DENIED.

  • If pInfoStruct is NULL, return an error other than one of the errors specified in the preceding table.

  • If dwPid is not specified in the SupportedTransportsList, return an error other than those specified in the preceding table.

  • Call the abstract interface Invoke DIMSVC method specifying the operation and the parameters to enable RRAS server to perform the required management task.

  • If the RRAS server successfully processes the request, return the information in pInfoStruct and with the information provided by the RRAS server and return ERROR_SUCCESS (0x00000000). Otherwise return the error result provided by the RRAS server.

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