Ports Class

Reference

Definition

Namespace:: Microsoft.VisualBasic.Devices

Assembly:: Microsoft.VisualBasic.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a property and a method for accessing the computer's serial ports.

public ref class Ports

public class Ports

type Ports = class

Public Class Ports

Inheritance: Object
Ports

Examples

This example describes how to send strings to the computer's COM1 serial port.

The Using block allows the application to close the serial port even if it generates an exception. All code that manipulates the serial port should appear within this block, or within a Try...Catch...Finally block with a call to use the Close method.

The WriteLine method sends the data to the serial port.

Sub SendSerialData(ByVal data As String)
    ' Send strings to a serial port.
    Using com1 As IO.Ports.SerialPort = 
            My.Computer.Ports.OpenSerialPort("COM1")
        com1.WriteLine(data)
    End Using
End Sub

For more information, see How to: Send Strings to Serial Ports.

Remarks

The My.Computer.Ports object provides a straightforward entry point for accessing the .NET Framework serial port class, SerialPort.

The following table lists examples of tasks involving the My.Computer.Ports object.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to a serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From Serial Ports
Show available serial ports	How to: Show Available Serial Ports

Availability by Project Type

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

Constructors

Ports()

Initializes a new instance of the Ports class.

Properties

SerialPortNames

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

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OpenSerialPort(String, Int32, Parity, Int32, StopBits)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32, Parity, Int32)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32, Parity)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32)	Creates and opens a SerialPort object.
OpenSerialPort(String)	Creates and opens a SerialPort object.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa