GetSystemPorts Method

Returns a collection of the names of COM ports in the system.

Syntax

[Visual Basic]
object.GetSystemPorts()

[C#]
object.GetSystemPorts()

[C++]
object->GetSystemPorts()

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Return Value

A StringCollection containing the names of the COM ports in the system.

Default

Empty

Remarks

This property returns the names of the ports that exist on the system, including ports that are in use by other processes (that is, each port that cannot currently be opened). To get a list of all ports on the system that are openable, use the GetAvailableSystemPorts method.

Errors

If GPS ToolKit is unable to determine the COM ports on the system, SystemPortsException is thrown. It is likely, however, you will still be able to open a port directly using the Open() method.

Example

[Visual Basic]
Dim SystemPorts As System.Collections.Specialized.StringCollection
SystemPorts = myGPSToolKit.GetSystemPorts()


[C#]
System.Collections.Specialized.StringCollection SystemPorts;
SystemPorts = myGPSToolKit.GetSystemPorts();


[C++]
System::Collections::Specialized::StringCollection *SystemPorts;
SystemPorts = myGPSToolKit->GetAvailablePorts();

See Also