MprAdminInterfaceUpdateRoutes 函数 (mprapi.h)

  • 项目

MprAdminInterfaceUpdateRoutes 函数请求指定的路由器管理器更新其指定接口的路由信息。

语法

DWORD MprAdminInterfaceUpdateRoutes(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwProtocolId,
  [in] HANDLE            hEvent
);

参数

[in] hMprServer

正在更新信息的路由器的句柄。 通过调用 MprAdminServerConnect 获取此句柄。

[in] hInterface

要更新的接口的句柄。 通过调用 MprAdminInterfaceCreate 获取此句柄。

[in] dwProtocolId

一个 DWORD 值，该值指定哪个路由器管理器正在更新其路由信息。 路由器为每个传输协议使用不同的路由器管理器。 下表列出了 dwTransportId 的可接受值。

值 传输 (协议系列)
PID_ATALK AppleTalk
PID_IP Internet 协议版本 4
PID_IPX Internet 数据包交换
PID_NBF NetBIOS 帧协议
PID_IPV6 Windows Server 2008 或更高版本：Internet 协议版本 6

[in] hEvent

在尝试更新指定接口的路由信息时发出信号的事件的句柄。 如果 为 NULL，则该函数是同步的。 如果 hMprServer 指定远程路由器，则调用应用程序必须为此参数指定 NULL。

返回值

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

值 含义
ERROR_ACCESS_DENIED
 调用应用程序没有足够的权限。
ERROR_INTERFACE_NOT_CONNECTED
 指定的接口未连接。 因此，无法更新路由。
ERROR_INVALID_HANDLE
 hInterface 值无效。
ERROR_NO_SUCH_INTERFACE
 指定的传输未在指定的接口上运行。
ERROR_UNKNOWN_PROTOCOL_ID
 dwTransportId 值与任何路由器管理器都不匹配。
ERROR_UPDATE_IN_PROGRESS
 此接口上的路由信息更新操作已在进行中。
等待
 接口正在更新路由信息。 调用应用程序必须等待 hEvent 指定的事件对象。 发出事件信号后，可以通过调用 MprAdminInterfaceQueryUpdateResult 来获取更新操作的状态。

注解

dwTransportId 参数指定传输协议和唯一路由器管理器，因为路由器对每个传输使用不同的路由器管理器。

要求

要求 值
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

另请参阅

MprAdminInterfaceCreate

MprAdminInterfaceQueryUpdateResult

MprAdminServerConnect

路由器管理功能

路由器管理参考