NavData.ActiveRoute Property

Returns the current destination arrival status.

Syntax

[Visual Basic]
object.ActiveRoute

[C#]
object.ActiveRoute

[C++]
object->ActiveRoute

Parameters

object

An object expression that evaluates to a NavData object.

Return Value

A Route object representing the route which is currently active in the GPS.

Remarks

• This property reflects the active route in the GPS, it is not possible to change the active route on the GPS programatically.
• This data is only reported when using the NMEA 0183 protocol. If there is no route active in the GPS or the Garmin protocol is currently in use, this route will have no waypoints and its name will be empty.
• To change or add a stored route on the GPS, use the GPSToolKit.AddRoute() method (only available when using the Garmin protocol).

Errors

None

Example

[Visual Basic]
Dim activeRoute As Route

'Get active route status
activeRoute = myGPSToolKit.NavigationData.ActiveRoute


[C#]
Route activeRoute;

// Get active route status
activeRoute = myGPSToolKit.NavigationData.ActiveRoute;


[C++]
Route *activeRoute;

// Get active route status
activeRoute = myGPSToolKit->NavigationData->ActiveRoute;

See Also