RtmGetNextRoute 函式

[路由 表管理員第 2 版 API 已取代此 API,且無法超過 Windows Server 2003。 應用程式應該使用路由表管理員第 2 版 API。]

RtmGetNextRoute函式會從資料表中指定的路由子集傳回下一個路由。

語法

DWORD RtmGetNextRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

參數

ProtocolFamily [in]

指定要擷取的通訊協定系列,例如 IP 或 IPX。

EnumerationFlags [in]

指定應該列舉哪些路由。 此參數會將已刪除的路由集限制為下列旗標所定義的子集,以及 CriteriaRoute 參數所指向之結構對應成員中的值。 旗標與 RtmCreateEnumerationHandle中使用的旗標相同。

路由 [in, out]

在輸入上, 路由 會指向通訊協定系列特定結構 ( RTM_IP_ROUTERTM_IPX_ROUTE)

呼叫函式會提供這個 結構的成員值。 這些值與 EnumerationFlags 參數搭配使用,指定要從中傳回路由的集合。

在輸出上, Route 會指向結構,該結構會接收符合指定準則的第一個路由。

傳回值

如果函式成功,傳回值 會NO_ERROR

如果函式失敗,傳回值就是下列其中一個錯誤碼。

Description
ERROR_INVALID_PARAMETER
其中一個參數無效。
ERROR_NO_ROUTES
沒有符合指定準則的路由。
ERROR_NO_SYSTEM_RESOURCES
資源不足,無法執行作業。

備註

路由會依照下列順序傳回:

  1. 網路編號
  2. 路由通訊協定
  3. 介面識別碼
  4. 下一個躍點位址

此函式比對應的列舉控制碼函式更有效率。

規格需求

需求
最低支援的用戶端
都不支援
最低支援的伺服器
Windows 2000 Server [僅限傳統型應用程式]
伺服器終止支援
Windows Server 2003
標頭
Rtm.h
程式庫
Rtm.lib
DLL
Rtm.dll

另請參閱

路由表管理員第 1 版參考

路由表管理員第 1 版函式

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetFirstRoute