Edit

Share via

RtmCreateRouteListEnum function (rtmv2.h)

  • Article

The RtmCreateRouteListEnum function creates an enumeration of routes on the specified route list.

Syntax

DWORD RtmCreateRouteListEnum(
  [in]  RTM_ENTITY_HANDLE     RtmRegHandle,
  [in]  RTM_ROUTE_LIST_HANDLE RouteListHandle,
  [out] PRTM_ENUM_HANDLE      RtmEnumHandle
);

Parameters

[in] RtmRegHandle

Handle to the client obtained from a previous call to RtmRegisterEntity.

[in] RouteListHandle

Handle to the route list to enumerate that is obtained from a previous call to RtmCreateRouteList.

[out] RtmEnumHandle

On input, RtmEnumHandle is a pointer to NULL.

On output, RtmEnumHandle receives a pointer to a handle to the enumeration. Use this handle in all subsequent calls to functions that enumerate the list of routes.

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 Meaning
ERROR_NOT_ENOUGH_MEMORY
 There is not enough memory to complete this operation.
 
 

Remarks

When the enumeration handle is no longer required, release it by calling RtmDeleteEnumHandle.

For sample code using this function, see Use a Client-Specific Route List.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header rtmv2.h
Library Rtm.lib
DLL Rtm.dll

See also

RtmDeleteEnumHandle

RtmGetListEnumRoutes