MprAdminInterfaceQueryUpdateResult function

The MprAdminInterfaceQueryUpdateResult function returns the result of the last request to a specified router manager to update its routes for an interface. For more information, see MprAdminInterfaceUpdateRoutes.

Syntax


DWORD MprAdminInterfaceQueryUpdateResult(
  _In_  MPR_SERVER_HANDLE hMprServer,
  _In_  HANDLE            hInterface,
  _In_  DWORD             dwProtocolId,
  _Out_ LPDWORD           lpdwUpdateResult
);

Parameters

hMprServer [in]

Handle to the router from which information is being retrieved. Obtain this handle by calling MprAdminServerConnect.

hInterface [in]

Handle to the interface. This handle is obtained from a previous call to MprAdminInterfaceCreate.

dwProtocolId [in]

A DWORD value that specifies which router manager is being queried. The router uses a different router manager for each transport protocol. Acceptable values for dwTransportId are listed in the following table.

ValueTransport (Protocol Family)
PID_ATALKAppleTalk
PID_IPInternet Protocol version 4
PID_IPXInternet Packet Exchange
PID_NBFNetBIOS Frames Protocol
PID_IPV6Windows Server 2008 or later: Internet Protocol version 6

 

lpdwUpdateResult [out]

Pointer to a DWORD variable. This variable receives the result of the last call to MprAdminInterfaceUpdateRoutes.

Return value

If the function succeeds, the return value is NO_ERROR.

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

ValueMeaning
ERROR_ACCESS_DENIED

The calling application does not have sufficient privileges.

ERROR_INTERFACE_NOT_CONNECTED

The specified interface is not connected; the result of the last update is no longer available.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

ERROR_INVALID_PARAMETER

The lpdwUpdateResult parameter is NULL.

ERROR_NO_SUCH_INTERFACE

The specified transport is not running on the specified interface.

ERROR_UNKNOWN_PROTOCOL_ID

The dwProtocolId value does not match any supported router manager.

 

Remarks

The dwProtocolId parameter specifies both a transport and a router manager, since the router maintains a router manager for each transport.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mprapi.h

Library

Mprapi.lib

DLL

Mprapi.dll

See also

Router Management Reference
Router Administration Functions
MprAdminInterfaceCreate
MprAdminInterfaceUpdateRoutes
MprAdminServerConnect

 

 

Community Additions

ADD
Show: