| UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:rtmv2.RtmGetListEnumRoutes |
RtmGetListEnumRoutes function (rtmv2.h) |
The RtmGetListEnumRoutes function enumerates a set of routes in a specified route list. |
|
rras\rtmgetlistenumroutes.htm |
RRAS |
9ee40466-63e9-40c4-82bf-45f819d0ae58 |
12/05/2018 |
RtmGetListEnumRoutes, RtmGetListEnumRoutes function [RAS], _rtmv2ref_rtmgetlistenumroutes, rras.rtmgetlistenumroutes, rtmv2/RtmGetListEnumRoutes |
rtmv2.h |
Windows |
None supported |
Windows 2000 Server [desktop apps only] |
Rtm.lib |
Rtm.dll |
Windows |
19H1 |
|
|
|
|
|
|
The RtmGetListEnumRoutes function enumerates a set of routes in a specified route list.
Handle to the client obtained from a previous call to RtmRegisterEntity.
Handle to the route list to enumerate.
On input, NumRoutes is a pointer to a UINT value that specifies the maximum number of routes that can be received by RouteHandles.
On output, NumRoutes receives the actual number of routes received by RouteHandles.
On input, DestInfo is a pointer to an array of RTM_DEST_INFO structures.
On output, DestInfo is filled with the requested destination information.
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 value pointed to by NumRoutes is larger than the maximum number of routes a client is allowed to retrieve with one call. Check RTM_REGN_PROFILE for the maximum number of routes that the client is allowed to retrieve with one call. |
Call this function repeatedly to retrieve all routes.
There are no more routes to enumerate when the routing table manager returns zero in NumRoutes.
For sample code using this function, see Use a Client-Specific Route List.