About GPS ToolKit
Introduction
Purchasing GPS ToolKit
Redistributing GPS ToolKit
License Agreement
Support
Getting Started
How to Use GPS ToolKit
Adding GPS ToolKit to a Visual Basic Project
Adding GPS ToolKit to a Visual C++ Project
Adding GPS ToolKit to an Excel Worksheet
Setting up the GPS
How to Use Events
Handling Events in Visual Basic
Handling Events in Visual C++
Handling Events in Microsoft Excel
GPS ToolKit Sample Projects
Handling GPS ToolKit Errors
Reference
Properties
Altitude
AltitudeUnits
ArrivedAtDest
AutomaticOperation
BaudRate
CrossTrackError
DegLabel
DestClosingVelocity
DestWptID
DestWptLatitude
DestWptLongitude
DistUnits
DGPSRefStationID
FixDateTime
FixGood
FixQuality
FixSatellitePRNs
GeoidHeightAboveWGS84Ellipsoid
HDOP
Latitude
LatLonFormat
Longitude
MagVariation
MinLabel
ModeIndicator
NumSatellitesInFix
NumSatellitesInView
OperationMode
OrigToDestMagBearing
OrigToDestTrueBearing
OriginWptID
PDOP
PortHandle
PortName
RangeToDest
RouteContainsAllWpts
RouteName
SatelliteInViewPRNs
SecLabel
Speed
SpeedUnits
TimeSinceLastDGPSUpdate
TrueBearingToDest
TrueCourse
VDOP
WptsInRoute
Methods
Close
GetSatelliteInfo
GetWptLocation
Open
OpenFile
Events
FixUpdate
FileComplete
NavUpdate
RawDataReceived
SatelliteUpdate

GPS ToolKit Events

GPS ToolKit events are signals that GPS ToolKit sends to your application when GPS data has been updated. For example, when a fix update has occurred you can use GPS ToolKit's FixUpdate event to get the updates positional, speed, course, and status data.

All variables passed into the event handling function are of type VARIANT. Each event is listed with its variables (arguments) and their associated variant types below. If data is not available for a particular variable, the variable's type is VT_EMPTY.

The events fired by the GPS ToolKit are as follows:

Event Arguments Description
FixUpdate VT_BOOL(Boolean/bool) FixGood
VT_DATE(Date/COleDateTime) FixDateTime
VT_BSTR(String/BSTR) Latitude
VT_BSTR(String/BSTR) Longitude
VT_R8(Double/double) Altitude
VT_R8(Double/double) Speed
VT_R8(Double/double) TrueCourse
Fired when updated fix data has been received from the GPS.
RawDataReceived VT_BSTR(String/BSTR) RawData
VT_I4(Integer/long) NumBytesRead
Fired when a complete data sentence has been received from the GPS.
SatelliteUpdate VT_BOOL(Boolean/bool) AutomaticOperation
VT_I2(Integer/short) OperationMode
VT_I2(Integer/short) NumSatellitesInView
VT_R8(Double/double) HDOP
VT_R8(Double/double) PDOP
VT_R8(Double/double) VDOP
VT_ARRAY | VT_VARIANT(VB array/SAFEARRAY) FixSatellitePRNs
VT_ARRAY | VT_VARIANT(VB array/SAFEARRAY) SatelliteInViewPRNs
Fired when updated satellite information has been received from the GPS.
NavUpdate VT_BSTR(String/BSTR) OriginWptID
VT_BSTR(String/BSTR) DestWptID
VT_BSTR(String/BSTR) DestWptLatitude
VT_BSTR(String/BSTR) DestWptLongitude
VT_R8(Double/double) TrueBearingToDest
VT_R8(Double/double) RangeToDest
VT_BSTR(String/BSTR) CrossTrackError
VT_R8(Double/double) DestClosingVelocity
VT_BOOL(Boolean/bool) DestArrivalAlarm
VT_BSTR(String/BSTR) RouteName
VT_ARRAY | VT_VARIANT(VB array/SAFEARRAY) WptsInRoute
Fired when updated navigation information has been received from the GPS.
FileComplete None Fired when file read has completed or been cancelled.

For detailed instructions and examples of handling GPS ToolKit events in Visual Basic, see Handling Events in Visual Basic or for Visual C++ see Handling Events in Visual C++. For other environments, please consult your development environment's documentation regarding ActiveX events.