C++ SDK

◆ LoadOFGRoute()

static int CApplicationAPI::LoadOFGRoute ( LpError  lpError,
LPCTSTR  lpszFileName,
int  nStartFromIndex,
int  nFlags,
DWORD  dwMaxTime 
)
static

Loads an offroad guided route (OFG) and starts navigation following that route.

Parameters
lpErrorAdditional error information returned from Drive.
lpszFileNamePath and file name of the OFG file to be loaded
nStartFromIndexStart index of the route
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if file was found and loaded, 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.