AddEntryToItinerary()

static int CApplicationAPI::AddEntryToItinerary ( LpError  lpError, LPCTSTR  lpszItineraryName, SStopOffPoint *  lpStopOffPoint, UINT  nIndex, DWORD  dwMaxTime = DEFAULT_MAX_TIME  )

static

The function adds new waypoint to taken itinerary.

Parameters

lpError	Additional error information returned from Drive.
lpszItineraryName	Name of itinerary where new item will be added.
lpStopOffPoint	Reference to instance of SStopOffPoint class containing informations about waypoint to be added to itinerary.
nIndex	Index of position where new waypoint will be inserted.
dwMaxTime	Maximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.

Returns

1 if successful, other value otherwise.

If nIndex is lower than 0 or higher than number of items in itinerary the waypoint will be added at the end of list.

It is necessary to set Location, nPointType and Caption members of StopOffPoint (see SStopOffPoint class).

See Coordinates conversion section in TROUBLESHOOTING page.

Possible error codes returned from Drive are:

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