The MprAdminInterfaceUpdateRoutes function requests a specified router manager to 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 );
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. 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 calling application 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. |
The dwTransportId parameter specifies both a transport (for example, IP or IPX) and a unique router manager because Windows 2000 router uses a different router manager for each transport.
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Administration Functions, MprAdminInterfaceCreate, MprAdminInterfaceQueryUpdateResult, MprAdminServerConnect