NavData.ArrivedAtDest Property

Returns the current destination arrival status.

Syntax

[Visual Basic]
object.ArrivedAtDest

[C#]
object.ArrivedAtDest

[C++]
object->ArrivedAtDest

Parameters

object

An object expression that evaluates to a NavData object.

Return Value

A Boolean value representing the destination arrival status. A value of true indicates that the GPS has arrived at the destination waypoint. False indicates an the GPS has not yet arrived at the destination waypoint. This value is deterimned solely by the GPS. Therefore, different GPS units may define different criteria to determine when arrival has occured.

Remarks

None

Default

False

Errors

None

Example

[Visual Basic]
Dim arrived As Boolean

'Get arrival status
arrived = myGPSToolKit.NavigationData.ArrivedAtDest


[C#]
Boolean arrived;

// Get arrival status
arrived = myGPSToolKit.NavigationData.ArrivedAtDest;


[C++]
Boolean arrived;

// Get arrival status
arrived = myGPSToolKit->NavigationData->ArrivedAtDest;

See Also