GetItineraryList()

static int CApplicationAPI::GetItineraryList ( LpError  lpError, LPCTSTR  lpszItineraryName, SStopOffPoint *&  PointsArr, int &  nWayPointsCount, DWORD  dwMaxTime = DEFAULT_MAX_TIME  )

static

The function returns list of waypoints in itinerary.

Parameters

lpError	Additional error information returned from Drive.
lpszItineraryName	Name of itinerary from which waypoints will be retrieved. If the name of itinerary is "default", function returns the list of waypoints from current route.
PointsArr	Array of SStopOffPoint which will contain waypoints of itinerary after function execution.
dwMaxTime	Maximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.

Returns

1 if successful, other value otherwise.

Possible error codes returned from Drive are:

• 0 - Function not succeeded.
• 1 - Function succeeded.
• 2 - Drive not succeeded.
• 3 - Function reached timeout.