[路由 表管理員第 2 版 API 已取代此 API，且無法超過 Windows Server 2003。 應用程式應該使用路由表管理員第 2 版 API。]
RtmGetFirstRoute函式會從資料表中指定路由子集傳回第一個路由。
語法
DWORD RtmGetFirstRoute(
_In_ DWORD ProtocolFamily,
_In_ DWORD EnumerationFlags,
_Inout_ PVOID Route
);
參數
-
ProtocolFamily [in]
-
指定要擷取的通訊協定系列，例如 IP 或 IPX。
-
EnumerationFlags [in]
-
指定這些旗標所定義子集的已刪除路由集，以及 CriteriaRoute 參數所指向之結構對應成員中的值。 旗標與 RtmCreateEnumerationHandle中使用的旗標相同。
-
路由 [in， out]
-
在輸入上， 路由 會指向通訊協定系列特定結構 ， ( RTM_IP_ROUTE 或 RTM_IPX_ROUTE) 。
呼叫函式會提供這個 結構的成員值。 這些值會與 EnumerationFlags 參數結合，指定要從中傳回路由的集合。
輸出輸出中， Route 會指向符合指定準則的第一個路由。
傳回值
如果函式成功，傳回值會NO_ERROR。
如果函式失敗，傳回值就是下列其中一個錯誤碼。
| 值 | Description |
|---|---|
|
其中一個參數無效。 |
|
沒有符合指定準則的路由。 |
|
資源不足，無法執行作業。 |
備註
路由會依照下列順序傳回：
- 網路編號
- 路由通訊協定
- 介面識別碼
- 下一個躍點位址
此函式比對應的列舉控制碼函式 RtmEnumerateGetNextRoute效率低。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 |
都不支援 |
| 最低支援的伺服器 |
Windows 2000 Server [僅限桌面應用程式] |
| 伺服器終止支援 |
Windows Server 2003 |
| 標頭 |
|
| 程式庫 |
|
| DLL |
|