RtmCreateRouteList function (rtmv2.h)

The RtmCreateRouteList function creates a list in which the caller can keep a copy of the routes it owns.

Syntax

DWORD RtmCreateRouteList(
  [in]  RTM_ENTITY_HANDLE      RtmRegHandle,
  [out] PRTM_ROUTE_LIST_HANDLE RouteListHandle
);

[in] RtmRegHandle

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

[out] RouteListHandle

On input, RouteListHandle is a pointer to NULL.

On output, RouteListHandle receives a pointer to a handle to the new route list.

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.

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

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