RtmGetNextHopInfo function (rtmv2.h)

The RtmGetNextHopInfo function returns information about the specified next hop.

Syntax

DWORD RtmGetNextHopInfo(
  [in]  RTM_ENTITY_HANDLE  RtmRegHandle,
  [in]  RTM_NEXTHOP_HANDLE NextHopHandle,
  [out] PRTM_NEXTHOP_INFO  NextHopInfo
);

[in] RtmRegHandle

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

[in] NextHopHandle

Handle to the next hop.

[out] NextHopInfo

On input, NextHopInfo a pointer to an RTM_NEXTHOP_INFO structure.

On output, NextHopInfo is filled with the requested next-hop information.

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.

When the next hop handle is no longer required, release it by calling RtmDeleteNextHop.

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