MprAdminInterfaceUpdateRoutes

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceUpdateRoutes function requests that a specified router manager update its routing information for a specified interface.

DWORD  MprAdminInterfaceUpdateRoutes(
  MPR_SERVER_HANDLE hMprServer,    // handle to router
  HANDLE hInterface,               // handle to interface
  DWORD dwTransportId,             // identifies the router manager
  HANDLE hEvent                    // event to signal when
                                   // update complete
);

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. Obtain this handle by calling MprAdminInterfaceCreate.

dwTransportId

Identifies the router manager that should update its routing information. (Windows NT router uses a different router manager for each transport.)

hEvent

Handle to an event that will be signaled when the attempt to update routing information for this interface has completed. If this value is NULL, then the function is synchronous. If hMprServer specifies a remote router, the caller must specify NULL for this parameter, .

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. Therefore, routes cannot be updated.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

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 of the router managers.

ERROR_UPDATE_IN_PROGRESS

A routing information update operation is already in progress on this interface.

PENDING

The interface is in the process of updating routing information. The caller should wait on the event object specified by hEvent. After the event is signaled, the status of the update operation can be obtained by calling MprAdminInterfaceQueryUpdateResult.

Remarks

The dwTransportId parameter specifies both a transport (for example, IP or IPX) and a unique router manager, since a Windows NT router uses a different 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, MprAdminInterfaceQueryUpdateResult, MprAdminServerConnect