MprAdminMIBEntrySet function (mprapi.h)

Article
02/22/2024

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

Syntax

DWORD MprAdminMIBEntrySet(
  [in] MIB_SERVER_HANDLE hMibServer,
  [in] DWORD             dwProtocolId,
  [in] DWORD             dwRoutingPid,
  [in] LPVOID            lpEntry,
  [in] DWORD             dwEntrySize
);

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] lpEntry

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 set and the value to be assigned to the variable.

[in] dwEntrySize

Specifies the size, in bytes, of the data pointed to by the lpEntry 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.

Remarks

Do not pass in NULL for the lpEntry 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