RtmIsRoute 函式

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

RtmIsRoute函式會判斷指定的目的地網路是否存在一或多個路由。 如果是,函式會傳回該網路的最佳路由資訊。

語法

BOOL RtmIsRoute(
  _In_  DWORD ProtocolFamily,
  _In_  PVOID Network,
  _Out_ PVOID BestRoute
);

參數

ProtocolFamily [in]

指定 Network 參數所指向的資料結構類型,例如 IP_NETWORKIPX_NETWORK

網路 [in]

指定通訊協定系列特定網路編號資料的 結構的指標。 此資料會識別呼叫端搜尋路由資訊的網路。

BestRoute [out]

如果有的話,接收目前最佳路由資訊的通訊協定系列特定結構指標。

傳回值

傳回值是下列其中一個程式碼。

Description
TRUE
至少有一個路由傳送至指定的網路。 BestRoute參數所指向的結構中會傳回最佳路由。
FALSE
沒有指定網路的路由,或作業失敗。 呼叫 GetLastError 以取得詳細資訊:
NO_ERROR
作業成功,但沒有路由傳送至指定的網路。
ERROR_INVALID_PARAMETER
ProtocolFamily參數的值不會對應到任何已安裝的通訊協定系列。
ERROR_NO_SYSTEM_RESOURCES
資源不足,無法執行作業。

規格需求

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

另請參閱

路由表管理員第 1 版參考

路由表管理員第 1 版函式

GetLastError

IP_NETWORK

IPX_NETWORK

RTMv1 通訊協定系列識別碼