RouteContainsAllWpts Property
Returns a flag indicating if the current route lists all waypoints in the route,
or only waypoints that have not yet been reached.
Syntax
Visual Basic
object.RouteContainsAllWpts
Visual C++
object.GetRouteContainsAllWpts()
| Part
| Description |
| object |
An object expression that evaluates to a GPS ToolKit object. |
Example
Visual Basic
Dim allWpts As Boolean
'Determine whether the route waypoint list holds all waypoints or
'just the ones that have not yet been reached
allWpts = myGPSToolKit.RouteContainsAllWpts
Visual C++
_variant_t vtAllWpts;
// Determine whether the route waypoint list holds all waypoints or
// just the ones that have not yet been reached
vtAllWpts = m_myGPSToolKit.GetRouteContainsAllWpts();
bool allWpts = (bool)vtAllWpts;
Remarks
None
Default
False (VT_BOOL)
Returns
A VARIANT (type VT_BOOL/bool) indicating if all route waypoints are listed in the
WptsInRoute property. A value of true indicates that all waypoints in the route are listed.
False indicates that only the waypoints that have not yet been reached are listed.
invalid fix.
Errors
None
See Also
WptsInRoute property, RouteName event, NavUpdate event
|