LoadComputedRoute() [4/4]

static int LoadComputedRoute ( out SError  Error, string  RoutePath, UInt32  StartWaypointID, Int32  MaxTime  )

inlinestatic

This function loads a pre-computed route from a file and starts navigation following that route.

Parameters

Error	Additional error information returned from Drive.
RoutePath	Path and filename of the RSAV file, from which is the saved route loaded.
StartWaypointID	ID of start waypoint
MaxTime	Maximum time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.

Returns

1 if successful, other value otherwise.

The StartWaypointID of the Start point is 1. The first waypoint has the ID 2 and so on.

Possible error codes returned from Drive are:

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

References CApplicationAPI.LoadComputedRoute(), and SError.SizeOf().