C++ SDK

◆ StopNavigation()

static int CApplicationAPI::StopNavigation ( LpError  lpError,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function stops navigation, cancels the route and returns Drive application to main screen.

Parameters
lpErrorAdditional error information returned from Drive.
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.