RtmFindNextHop function (rtmv2.h)
The RtmFindNextHop function finds a specific next hop in a client's next-hop list.
Syntax
DWORD RtmFindNextHop(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] PRTM_NEXTHOP_INFO NextHopInfo,
[out] PRTM_NEXTHOP_HANDLE NextHopHandle,
[out] PRTM_NEXTHOP_INFO *NextHopPointer
);
Parameters
[in] RtmRegHandle
Handle to the client obtained from a previous call to RtmRegisterEntity.
[in] NextHopInfo
Pointer to an RTM_NEXTHOP_INFO structure that contains information identifying the next hop to find. Use the NextHopAddress and InterfaceIndex members to identify the next hop to find.
[out] NextHopHandle
If a handle must be returned: On input, NextHopPointer is a pointer to NULL. On output, if the client owns the next hop, NextHopPointer receives a pointer to the next-hop handle; otherwise, NextHopPointer remains unchanged.
If a handle does not need to be returned: On input, NextHopPointer is NULL.
[out] NextHopPointer
If a pointer must be returned: On input, NextHopPointer is a pointer to NULL. On output, if the client owns the next hop, NextHopPointer receives a pointer to the next-hop; otherwise, NextHopPointer remains unchanged.
If a pointer does not need to be returned: On input, NextHopPointer 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 |
|---|---|
|
The calling client does not own this next hop. |
|
The specified next hop was not found. |
Remarks
The NextHopPointer is valid as long as the client has not released NextHopHandle.
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 |