Skip to content

Latest commit

 

History

History
195 lines (134 loc) · 5.09 KB

nf-mprapi-mpradminmibentryget.md

File metadata and controls

195 lines (134 loc) · 5.09 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mprapi.MprAdminMIBEntryGet
MprAdminMIBEntryGet function (mprapi.h)
The MprAdminMIBEntryGet function retrieves the value of one of the variables exported by a routing protocol or router manager.
MprAdminMIBEntryGet
MprAdminMIBEntryGet function [RAS]
_mpr_mpradminmibentryget
mprapi/MprAdminMIBEntryGet
rras.mpradminmibentryget
rras\mpradminmibentryget.htm
RRAS
98e88364-4757-4b43-8316-6d4d9b3c2f29
12/05/2018
MprAdminMIBEntryGet, MprAdminMIBEntryGet function [RAS], _mpr_mpradminmibentryget, mprapi/MprAdminMIBEntryGet, rras.mpradminmibentryget
mprapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprAdminMIBEntryGet
mprapi/MprAdminMIBEntryGet
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprAdminMIBEntryGet

MprAdminMIBEntryGet function

-description

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

-parameters

-param hMibServer [in]

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

-param dwProtocolId [in]

Specifies the router manager that exported the variable.

-param dwRoutingPid [in]

Specifies the routing protocol that exported the variable.

-param lpInEntry [in]

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.

-param dwInEntrySize [in]

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

-param lplpOutEntry [out]

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 variable that was queried. Free this memory by calling MprAdminMIBBufferFree.

-param lpOutEntrySize [out]

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

-returns

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.

-see-also

MIB Structures

MprAdminMIBBufferFree

MprAdminMIBEntryGetFirst

MprAdminMIBEntryGetNext

MprAdminMIBEntrySet

MprAdminMIBServerConnect

Obtaining the MIB II Interfaces Table

Protocol Identifiers

Router Management MIB Functions

Router Management MIB Reference

Transport Identifiers