| title | description | ms.assetid | keywords | topic_type | api_name | api_location | api_type | ms.topic | ms.date | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RtmGetNextRoute function (Rtm.h) |
The RtmGetNextRoute function returns the next route from the specified subset of routes in the table. |
0f413276-2ace-4216-a1a0-1b3061bacc4a |
|
|
|
|
|
reference |
05/31/2018 |
[This API has been superseded by the Routing Table Manager Version 2 API and will not be available beyond Windows Server 2003. Applications should use the Routing Table Manager Version 2 API.]
The RtmGetNextRoute function returns the next route from the specified subset of routes in the table.
DWORD RtmGetNextRoute(
_In_ DWORD ProtocolFamily,
_In_ DWORD EnumerationFlags,
_Inout_ PVOID Route
);-
ProtocolFamily [in]
-
Specifies the protocol family of routes to retrieve, for example, IP or IPX.
-
EnumerationFlags [in]
-
Specifies which routes should be enumerated. This parameter limits the set of deleted routes to a subset defined by the following flags and the values in the corresponding members of the structure pointed to by the CriteriaRoute parameter. The flags are the same as those used in RtmCreateEnumerationHandle.
-
Route [in, out]
-
On input, Route points to a protocol-family-specific structure ( RTM_IP_ROUTE or RTM_IPX_ROUTE).
The calling function provides member values for this structure. These values, in conjunction with the EnumerationFlags parameter, specify the set from which to return routes.
On output, Route points to a structure that receives the first route that matched the specified criteria.
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 | Description |
|---|---|
|
One of the parameters is invalid. |
|
There are no routes that match the specified criteria. |
|
There are insufficient resources to carry out the operation. |
The routes are returned in the following order:
- Network number
- Routing protocol
- Interface identifier
- Next-hop address
This function is less efficient than the corresponding enumeration handle functions.
| Requirement | Value |
|---|---|
| Minimum supported client |
None supported |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| End of server support |
Windows Server 2003 |
| Header |
|
| Library |
|
| DLL |
|