RtmCreateNextHopEnum function (rtmv2.h)
The RtmCreateNextHopEnum enumerates the next hops in the next-hop list.
DWORD RtmCreateNextHopEnum( [in] RTM_ENTITY_HANDLE RtmRegHandle, [in] RTM_ENUM_FLAGS EnumFlags, [in] PRTM_NET_ADDRESS NetAddress, [out] PRTM_ENUM_HANDLE RtmEnumHandle );
Handle to the client obtained from a previous call to RtmRegisterEntity.
Specifies which next hops to include in the enumeration. The following flags are used.
Pointer to an RTM_NET_ADDRESS structure that contains the starting address of the enumeration. Specify NULL if EnumFlags contains RTM_ENUM_START.
On input, RtmEnumHandle is a pointer to NULL.
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
||A parameter contains incorrect information.|
||There is not enough memory to complete this operation.|
If EnumFlags contains RTM_ENUM_RANGE, use NetAddress to specify the range of the routing table to enumerate. For example, if a client sets NetAddress to 10/8, next hops in the range 10.0.0.0/8 to 10.255.255.255/32 are returned.
When the enumeration handle is no longer required, release it by calling RtmDeleteEnumHandle.
|Minimum supported client||None supported|
|Minimum supported server||Windows 2000 Server [desktop apps only]|