GetRoutes Method

Gets all routes from the GPS

Syntax

[Visual Basic]
object.GetRoutes()

[C#]
object.GetRoutes()

[C++]
object->GetRoutes()

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Return Value

A RouteCollection object containing all the routes in the GPS

Remarks

• This method returns every route stored in the GPS. To get a particular route, use this method and then iterate through the returned RouteCollection.htm object to find the route of interest.
• This method is only supported when using the Garmin protocol.
• It is not possible to delete a route programmatically; deleting a route can only be done from the GPS unit.
• If there are many routes in the GPS, this method may take some time to execute.

Errors

If using the NMEA 0183 protocol, this method will return a NotSupportedException exception.

Example

[Visual Basic]
' Get all routes in the GPS
Dim GPSRoutes As RouteCollection
GPSRoutes = myGPSToolKit.GetRoutes()


[C#]
// Get all routes in the GPS
RouteCollection GPSRoutes = myGPSToolKit.GetRoutes();


[C++]
// Get all routes in the GPS
RouteCollection *GPSRoutes = myGPSToolKit->GetRoutes();

See Also