RtmEnumerateGetNextRoute function

[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.

Remarks

Although routes are not returned in any particular order, each route in the enumeration is returned only once.

Requirements

See also

Routing Table Manager Version 1 Reference

Routing Table Manager Version 1 Functions

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle