RtmEnumerateGetNextRoute

[This is preliminary documentation and subject to change.]

The RtmEnumerateGetNextRoute function returns the next route entry in the enumeration started by a call to RtmCreateEnumerationHandle.

DWORD RtmEnumerateGetNextRoute(
  HANDLE   EnumerationHandle,  // handle that identifies enumeration
  PVOID    Route               // structure to receive next route
);
 

Parameters

EnumerationHandle

Handle that identifies the enumeration and specifies its scope. Obtain this handle by calling RtmCreateEnumerationHandle.

Route

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 Values

NO_ERROR

The next route in the enumeration was copied to the structure pointed to by the Route parameter.

ERROR_INVALID_HANDLE

The EnumerationHandle parameter is not valid.

ERROR_NO_MORE_ROUTES

No more routes exist in the enumeration.

ERROR_NO_SYSTEM_RESOURCES

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.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in rtm.h.
  Import Library: Link with rtm.lib.

See Also

RTM_IP_ROUTE, RTM_IPX_ROUTE, RtmCloseEnumerationHandle, RtmCreateEnumerationHandle