CApplicationAPI.GetRouteInfo Method

GPS NAVIGATION SDK version 8.3 build 40117

The function returns informations about computed route.

Parameters

Error

Additional error information returned from Drive.

RouteInfo

Reference to instance of SRouteInfo class which contains informations about route after function execution.

MaxTime

Maximum of time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.

Return Value

1 if successful, other value otherwise.

Remarks

GetRouteInfo fills in RouteInfo members.
Status member of RouteInfo determines status of the route. Possible values are:

• 0x0001 - Computing
• 0x0002 - Computed
• 0x0010 - EnumeratingJunctions
• 0x0020 - ReconstructRoute

Only if Status=0x0002 (Computed) you can be sure than other members of SRouteInfo are valid.
See SRouteInfo for information about other RouteInfo members .

Destination of route is possible obtain from GetItineraryList method.

Possible error codes returned from Drive are:

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

See Also

CApplicationAPI Class | ApplicationAPI Namespace

---