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 因特網通訊協定第 4 版
PID_IPX 因特網封包交換
PID_NBF NetBIOS 框架通訊協定
PID_IPV6 Windows Server 2008 或更新版本：因特網通訊協定第 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
程式庫 Mprapi.lib
Dll Mprapi.dll

另請參閱

MprAdminInterfaceCreate

MprAdminInterfaceQueryUpdateResult

MprAdminServerConnect

路由器管理功能

路由器管理參考