Close Method

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

Syntax

Visual Basic

object.Close

Visual C++

object.Close()

Example

Visual Basic

myGPSToolKit.Close

Visual C++

m_myGPSToolKit.Close();

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 OnFileComplete event.

• This method is called automatically when the object is destroyed.

Returns

Nothing

Errors

If the port is open and unable to be closed for any reason, or the file read is unable to be terminated, GPS ToolKit will throw an "Unexpected Error" exception.

See Also