RtmGetNextHopPointer function (rtmv2.h)

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(
  RTM_ENTITY_HANDLE  RtmRegHandle,
  RTM_NEXTHOP_HANDLE NextHopHandle,
  PRTM_NEXTHOP_INFO  *NextHopPointer
);

Parameters

RtmRegHandle

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

NextHopHandle

Handle to the next hop.

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

   
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

See also

RTM_NEXTHOP_INFO

RtmAddNextHop

RtmDeleteNextHop

RtmFindNextHop

RtmLockNextHop