RtmGetNextHopPointer function (rtmv2.h)

Article
02/22/2024

The RtmGetNextHopPointer function obtains a direct pointer to the specified next hop. The pointer allows the next-hop owner direct read access to the routing table manager's RTM_NEXTHOP_INFO structure.

Syntax

DWORD RtmGetNextHopPointer(
  [in]  RTM_ENTITY_HANDLE  RtmRegHandle,
  [in]  RTM_NEXTHOP_HANDLE NextHopHandle,
  [out] PRTM_NEXTHOP_INFO  *NextHopPointer
);

Parameters

[in] RtmRegHandle

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

[in] NextHopHandle

Handle to the next hop.

[out] NextHopPointer

If the client is the owner of the next hop, NextHopPointer receives a pointer to the next hop.

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_ACCESS_DENIED	The calling client does not own this next hop.
ERROR_INVALID_HANDLE	The handle is invalid.

Remarks

Clients should only use this pointer for read-only access.

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

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