C++ SDK

◆ DeleteEntryInItinerary()

static int CApplicationAPI::DeleteEntryInItinerary ( LpError  lpError,
LPCTSTR  lpszItineraryName,
UINT  nIndex,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function deletes waypoint from itinerary at taken position.

Parameters
lpErrorAdditional error information returned from Drive.
lpszItineraryNameName of itinerary from which waypoint will be deleted.
nIndexIndex in itinerary list which defines which waypoint will be deleted.
dwMaxTimeMaximum 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.