MibEntryGetFirst

[This is preliminary documentation and subject to change.]

The routing protocol should call MibEntryGetFirst to execute an SNMP MIB-style Get First request of the router manager or a peer protocol DLL.

DWORD ( * MibEntryGetFirst ) (
  DWORD TargetProtocolId,      // ID of DLL to process request
  DWORD InputDataSize,      // size of the data for the request
  PVOID InputData,      // address of the data for the request
  DWORD * OutputDataSize,      // size of the data returned
  PVOID OutputData      // address of the data returned
);
 

Parameters

TargetProtocolId

Specifies the ID of the DLL that should process this request. This parameter may be the ID of the router manager or the ID of a routing protocol.

InputDataSize

Specifies the size, in bytes, of the data to pass with the Get First request.

InputData

Pointer to the data to pass with the Get First request.

OutputDataSize

A pointer to a DWORD variable:

On input: This variable contains the size, in bytes, of the output buffer.

On output: This variable contains the size, in bytes, of data placed in the output buffer. If the initial size was not large enough, this variable contains the buffer size required to hold all of the output data.

OutputData

Pointer to a buffer to hold the data from the MIB entry.

Return Value

NO_ERROR

The Get First request completed successfully. The OutputData parameter points to the data from the MIB entry.

ERROR_CAN_NOT_COMPLETE

The operation failed.

ERROR_INVALID_PARAMETER

The size or content of the input data are incompatible with the request.

ERROR_INSUFFICIENT_BUFFER

The size of the output buffer provided is not large enough to hold the requested information. The required size is returned in the memory pointed to by the OutputDataSize parameter.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

Protocol Identifiers, MibEntryGet, MibEntryGetNext