MprAdminMIBEntryGetFirst function (mprapi.h)
The MprAdminMIBEntryGetFirst function retrieves the first variable of some set of variables exported by a protocol or router manager. The module that services the call defines first.
Syntax
DWORD MprAdminMIBEntryGetFirst(
[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. Obtain this handle by calling 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 servicing the call. The data structure should contain information that specifies the variable being queried.
[in] dwInEntrySize
Specifies the size, in bytes, of the data 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 servicing the call. The data structure receives the value of the first variable from the set of variables exported. Free this memory by calling MprAdminMIBBufferFree.
[out] lpOutEntrySize
Pointer to a DWORD variable. On successful return, this variable receives the size, in bytes, of the data structure that was 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 |
|---|---|
|
The caller does not have sufficient privileges. |
|
The dwRoutingPid variable does not match any installed routing protocol. |
|
The dwTransportId value does not match any installed transport/router manager. |
|
Insufficient resources to complete the operation. |
Remarks
Do not pass in NULL for the lpInEntry parameter because the resulting behavior is undefined.
Requirements
| Requirement | Value |
|---|---|
| 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
Router Management MIB Functions