RtmGetRouteInfo function (rtmv2.h)

Article
02/22/2024

The RtmGetRouteInfo function returns information for the specified route.

Syntax

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

Parameters

[in] RtmRegHandle

Handle to the client obtained from a previous call to RtmRegisterEntity.

[in] RouteHandle

Handle to the route to find.

[out] RouteInfo

If a pointer must be returned: On input, RouteInfo is a pointer to NULL. On output, RouteInfo receives a pointer to the route; otherwise, RouteInfo remains unchanged.

If a pointer does not need to be returned: On input, RouteInfo is NULL.

[out] DestAddress

If a pointer must be returned: On input, DestAddress is a pointer to NULL. On output, DestAddress receives a pointer to the destination's RTM_NET_ADDRESS structure; otherwise, DestAddress remains unchanged.

If a pointer does not need to be returned: On input, DestAddress is NULL.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value	Meaning
ERROR_INVALID_HANDLE	The handle is invalid.

Remarks

When the routes are no longer required, release them by calling RtmReleaseRouteInfo.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	rtmv2.h
Library	Rtm.lib
DLL	Rtm.dll