SystemPorts Property

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

Syntax

[Visual Basic]
object.SystemPorts

[C#]
object.SystemPorts

[C++]
object->SystemPorts

Parameters

object

An object expression that evaluates to a PortController object.

Return Value

A StringCollection containing the names of the serial 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, examine the AvailableSystemPorts property.

Errors

If PortController is unable to determine the COM ports on the system, an "Unable to enumerate system ports." exception 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 = myPortController.SystemPorts


[C#]
System.Collections.Specialized.StringCollection SystemPorts;
SystemPorts = myPortController.SystemPorts;


[C++]
System::Collections::Specialized::StringCollection *SystemPorts;
SystemPorts = myPortController->SystemPorts;

See Also