MprAdminMIBEntryGet

[This is preliminary documentation and subject to change.]

The MprAdminMIBEntryGet function retrieves the value of one of the variables exported by a routing protocol or router manager.

DWORD  MprAdminMIBEntryGet(
  MIB_SERVER_HANDLE hMibServer,    // handle to router
  DWORD dwTransportId,             // transport/router manager ID
  DWORD dwRoutingPid,              // routing protocol ID
  LPVOID lpInEntry,                // address of data to identify
                                   // variable 
  DWORD dwInEntrySize,             // size of data to identify variable
  LPVOID * lplpOutEntry,           // address of output data
  LPDWORD lpdwOutEntrySize         // size of output data
);

Parameters

hMibServer

Handle to the Windows NT router on which to execute this call. Obtain this handle by calling MprAdminMIBServerConnect.

dwTransportId

Identifies the router manager that exported the variable.

dwRoutingPid

Identifies the routing protocol that exported the variable.

lpInEntry

Pointer to an opaque data structure. The data structure's format is determined by the module servicing the call. The data structure should contain information to identify the variable being queried.

dwInEntrySize

Specifies the size, in bytes, of the data structure pointed to by lpInEntry.

lplpOutEntry

Pointer to a pointer variable. On successful return, this pointer variable points to an opaque data structure. The data structure's format is determined by the module servicing the call. The data structure will contain the value of the variable that was queried. Free this memory by calling MprAdminMIBBufferFree.

lpdwoutEntrySize

Pointer to a DWORD variable that, on successful return, contains the size in bytes of the data structure returned through the lplpOutEntry parameter.

Return Values

NO_ERROR

The entry was retrieved successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_CANNOT_COMPLETE

The dwRoutingPid variable doesn't match any installed routing protocol.

ERROR_UNKNOWN_PROTOCOL_ID

The dwTransportId value does not match any installed router manager.

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to complete the operation.

Remarks

Do not pass in NULL for the lpInEntry parameter, as the resulting behavior is undefined.

See Also

MprAdminMIBBufferFree, MprAdminMIBServerConnect, MprAdminMIBEntrySet, MprAdminMIBEntryGetFirst, MprAdminMIBEntryGetNext, Obtaining the MIB II Interfaces Table, Protocol Identifiers, Transport Identifiers