C++ SDK

◆ AddStopOffPointToHistory()

static int CApplicationAPI::AddStopOffPointToHistory ( LpError  lpError,
SHistoryRecord *  lpStopOffPoint,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function adds new item to History list.

Parameters
lpErrorAdditional error information returned from Drive.
lpStopOffPointReference to instance of SHistoryRecord type which contains informations about item to add.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

History list contains recent destinations. To add new item to History list fill in lpStopOffPoint members and call AddStopOffPointToHistory.

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.