GetWaypoints Method

Gets all waypoints from the GPS

Syntax

[Visual Basic]
object.GetWaypoints()

[C#]
object.GetWaypoints()

[C++]
object->GetWaypoints()

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Return Value

A WaypointCollection object containing all the waypoints in the GPS

Remarks

• This method returns every waypoint stored in the GPS.
• This method is only supported when using the Garmin protocol.
• It is not possible to delete a waypoint programmatically; deleting a waypoint can only be done from the GPS unit.
• If there are many waypoints 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 waypoints in the GPS
Dim GPSWaypoints As WaypointCollection
GPSWaypoints = myGPSToolKit.GetWaypoints()


[C#]
// Get all waypoints in the GPS
WaypointCollection GPSWaypoints = myGPSToolKit.GetWaypoints();


[C++]
// Get all waypoints in the GPS
WaypointCollection *GPSWaypoints = myGPSToolKit->GetWaypoints();

See Also