[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 RtmEnumerateGetNextRoute function returns the next-route entry in the enumeration started by a call to RtmCreateEnumerationHandle.
Syntax
DWORD RtmEnumerateGetNextRoute(
_In_ HANDLE EnumerationHandle,
_Out_ PVOID Route
);
Parameters
EnumerationHandle [in]
Handle that identifies the enumeration and specifies its scope. Obtain this handle by calling RtmCreateEnumerationHandle.
Route [out]
Pointer to a protocol-family-specific route structure ( RTM_IP_ROUTE or RTM_IPX_ROUTE). This structure will receive the next route in the enumeration.
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 | Description |
|---|---|
| ERROR_INVALID_HANDLE | The EnumerationHandle parameter is not valid. |
| ERROR_NO_MORE_ROUTES | There are no more routes in the enumeration. |
| ERROR_NO_SYSTEM_RESOURCES | There are insufficient resources to carry out the operation. |
Remarks
Although routes are not returned in any particular order, each route in the enumeration is returned only once.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| End of server support | Windows Server 2003 |
| Header | Rtm.h |
| Library | Rtm.lib |
| DLL | Rtm.dll |
See also
Routing Table Manager Version 1 Reference
Routing Table Manager Version 1 Functions
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
