C++ SDK

◆ AddItinerary() [1/2]

static int CApplicationAPI::AddItinerary ( LpError  lpError,
SStopOffPoint lstPointArr,
int  nSize,
LPCTSTR  lpszItineraryName,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function creates itinerary and fills it with items from PointArr.

Parameters
lpErrorAdditional error information returned from Drive.
lstPointArrList of items which will be inserted into itinerary.
nSizeSize of the lstPointArr array.
lpszItineraryNameItinerary name.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

AddItinerary creates itinerary and fills it with items from lstPointArr. lstPointArr array must contain at least one item otherwise itinerary will not be created. Existing itinerary with the same name will be overwriten.

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.