RtmDeleteNextHop function (rtmv2.h)

Article
02/22/2024

The RtmDeleteNextHop function deletes a next hop from the next-hop list.

Syntax

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

Parameters

[in] RtmRegHandle

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

[in] NextHopHandle

Handle to the next hop to delete. This parameter is optional and can be set to NULL; if it is NULL, the values in NextHopInfo are used to identify the next hop to delete.

[in] NextHopInfo

Pointer to a structure that contains information identifying the next hop to delete. This parameter is optional and can be set to NULL; if it is NULL, the handle in NextHopHandle is used to identify the next hop to delete.

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_NOT_ENOUGH_MEMORY	There is not enough memory to complete this operation.
ERROR_NOT_FOUND	The specified next hop was not found.

Remarks

If a client specifies a NextHopHandle, the client should not subsequently release the handle using RtmReleaseNextHops.

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