MprAdminInterfaceQueryUpdateResult

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

DWORD MprAdminInterfaceQueryUpdateResult(
  MPR_SERVER_HANDLE hMprServer,  // handle to router
  HANDLE hInterface,             // handle to interface
  DWORD dwTransportId,           // transport/router manager ID
  LPDWORD lpdwUpdateResult       // result of last route update
);

Parameters

hMprServer
[in] Handle to the Windows 2000 router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.
hInterface
[in] Handle to the interface. This handle is obtained from a previous call to MprAdminInterfaceCreate.
dwTransportId
[in] Specifies the DWORD variable that contains the transport identifier. This parameter identifies the router manager that updated its routing information.
lpdwUpdateResult
[out] Pointer to a DWORD variable. This variable receives the result of the last call to MprAdminInterfaceUpdateRoutes.

Return Values

If the function succeeds, the return value is NO_ERROR.

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

Value Meaning
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 dwTransportId value does not match any installed router manager.

Remarks

The dwTransportId parameter specifies both a transport and a router manager, since Windows 2000 router maintains a router manager for each transport.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Administration Functions, MprAdminInterfaceCreate, MprAdminInterfaceUpdateRoutes, MprAdminServerConnect