C++ SDK

◆ GetRouteStatus()

static int CApplicationAPI::GetRouteStatus ( LpError  lpError,
LPTSTR &  lpRouteStatus,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function returns informations about computed route in json format.

Parameters
lpErrorAdditional error information returned from Drive.
lpRouteStatusReference to instance of json string.
dwMaxTimeMaximum time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

Possible error codes returned are:

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