MprAdminInterfaceQueryUpdateResult

[This is preliminary documentation and subject to change.]

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

Handle to the Windows NT router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.

hInterface

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

dwTransportId

A DWORD variable containing the transport identifier. This parameter identifies the router manager that updated its routing information.

lpdwUpdateResult

A pointer to a DWORD variable. On successful return, this variable will contain the result of the last call to MprAdminInterfaceUpdateRoutes.

Return Values

NO_ERROR

Success

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

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 NT router maintains a unique router manager for each transport.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

MprAdminInterfaceCreate, MprAdminInterfaceUpdateRoutes, MprAdminServerConnect