MprAdminMIBEntryGetNext function (mprapi.h)

The MprAdminMIBEntryGetNext function retrieves the next variable of some set of variables exported by a protocol or router manager. The module that services the call defines next.

Syntax

DWORD MprAdminMIBEntryGetNext(
  [in]  MIB_SERVER_HANDLE hMibServer,
  [in]  DWORD             dwProtocolId,
  [in]  DWORD             dwRoutingPid,
  [in]  LPVOID            lpInEntry,
  [in]  DWORD             dwInEntrySize,
  [out] LPVOID            *lplpOutEntry,
  [out] LPDWORD           lpOutEntrySize
);

Parameters

[in] hMibServer

Handle to the router on which to execute this call. This handle is obtained from a previous call to MprAdminMIBServerConnect.

[in] dwProtocolId

Specifies the router manager that exported the variable.

[in] dwRoutingPid

Specifies the routing protocol that exported the variable.

[in] lpInEntry

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

[in] dwInEntrySize

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

[out] 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 that services the call. The data structure receives the value of the next variable from the set of variables exported. Free this memory by calling MprAdminMIBBufferFree.

[out] lpOutEntrySize

Pointer to a DWORD variable. This variable receives the size in bytes of the data structure returned through the lplpOutEntry parameter.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following values.

Value Description
ERROR_ACCESS_DENIED
The caller does not have sufficient privileges.
ERROR_CANNOT_COMPLETE
The dwRoutingPid variable does not 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 because the resulting behavior is undefined.

Requirements

   
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

MIB Structures

MprAdminMIBBufferFree

MprAdminMIBEntryGet

MprAdminMIBEntryGetFirst

MprAdminMIBServerConnect

Protocol Identifiers

Router Management MIB Functions

Router Management MIB Reference

Transport Identifiers