MprAdminMIBEntryGetFirst

[This is preliminary documentation and subject to change.]

The MprAdminMIBEntryGetFirst function retrieves the first variable of some set of variables exported by a protocol or router manager. The module servicing the call defines the semantics of first.

DWORD  MprAdminMIBEntryGetFirst(
  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

Size in bytes of the date pointed to by lpInEntry.

lplpOutEntry

Pointer to a pointer variable. On successful return, this pointer variable will point 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 first variable from the set of variables exported. Free this memory by calling MprAdminMIBBufferFree.

lpdwoutEntrySize

Pointer to a DWORD variable. On successful return, this variable 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 transport/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, MprAdminMIBEntryGet, MprAdminMIBEntryGetNext, Protocol Identifiers, Transport Identifiers