Ports.SerialPortNames Property

 
clsCompliantAlternativeNone.

Gets a collection of the names of the serial ports on the computer.

Namespace:   Microsoft.VisualBasic.Devices
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public ReadOnlyCollection<string> SerialPortNames { get; }

Property Value

Type: System.Collections.ObjectModel.ReadOnlyCollection<String>

A collection of the names of the serial ports on the computer.

The My.Computer.Ports.SerialPortNames property gets a collection of the names of the serial ports on the computer.

System_CAPS_noteNote

The port names returned by My.Computer.Ports.SerialPortNames may be incorrect when run on Windows 98. To prevent application errors, use exception handling, such as the Try...Catch...Finally statement or the Using statement, when using the port names to open ports.

The following table lists an example of a task involving the My.Computer.Ports.SerialPortNames property.

To

See

Show available serial ports

How to: Show Available Serial Ports in Visual Basic

Project type

Available

Windows Application

Yes

Class Library

Yes

Console Application

Yes

Windows Control Library

Yes

Web Control Library

No

Windows Service

Yes

Web Site

No

This example loops over all the strings that the My.Computer.Ports.SerialPortNames property returns. These strings are the names of the available serial ports on the computer.

Typically, a user selects which serial port the application should use from the list of available ports. In this example, the serial port names are stored in a ListBox control. For more information, see ListBox Control (Windows Forms).

Sub GetSerialPortNames()
    ' Show all available COM ports.
    For Each sp As String In My.Computer.Ports.SerialPortNames
        ListBox1.Items.Add(sp)
    Next
End Sub

This example requires:

  • A reference to the System namespace.

  • That your form have a ListBox control named ListBox1.

For more information, see How to: Show Available Serial Ports in Visual Basic.

.NET Framework
Available since 2.0
Return to top
Show: