rtmGetRouteInfo 函式 (rtmv2.h)

RtmGetRouteInfo 函式會傳回指定路由的資訊。

語法

DWORD RtmGetRouteInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [out] PRTM_ROUTE_INFO   RouteInfo,
  [out] PRTM_NET_ADDRESS  DestAddress
);

參數

[in] RtmRegHandle

從 先前呼叫 RtmRegisterEntity 取得的用戶端句柄。

[in] RouteHandle

要尋找之路由的句柄。

[out] RouteInfo

如果必須傳回指標：在輸入時， RouteInfo 是 NULL 的指標。 在輸出時， RouteInfo 會收到路由的指標;否則 ，RouteInfo 會保持不變。

如果不需要傳回指標：在輸入時， RouteInfo 為 NULL。

[out] DestAddress

如果必須傳回指標：在輸入時， DestAddress 是 NULL 的指標。 在輸出時， DestAddress 會接收目的地 RTM_NET_ADDRESS 結構的指標;否則， DestAddress 會保持不變。

如果不需要傳回指標：在輸入時， DestAddress 為 NULL。

傳回值

如果函式成功，傳回值會NO_ERROR。

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

值	意義
ERROR_INVALID_HANDLE	控制代碼無效。

 

 

備註

當不再需要路由時，請呼叫 RtmReleaseRouteInfo 加以釋放。

規格需求

需求	值
最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	rtmv2.h
程式庫	Rtm.lib
Dll	Rtm.dll

另請參閱

RTM_NET_ADDRESS

RTM_ROUTE_INFO

RtmReleaseRouteInfo