Close Method

Stops the reading of GPS data and closes the communications port if open.

Syntax

[Visual Basic]
object.Close()

[C#]
object.Close()

[C++]
object->Close()

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Return Value

None

Remarks

• If Close() is called when no port or file is open, no exception is thrown and execution will continue normally.
• This method closes the communications port when GPS ToolKit is reading from a GPS. If GPS ToolKit is reading from a file, this method terminates the file read and fires the FileComplete event.
• This method is called automatically when the object is destroyed.

Errors

None

Example

[Visual Basic]
myGPSToolKit.Close


[C#]
myGPSToolKit.Close();


[C++]
myGPSToolKit->Close();

See Also