Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Ports.OpenSerialPort Method (String, Int32, Parity, Int32, StopBits)

Creates and opens a SerialPort object.

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

public SerialPort OpenSerialPort(
	string portName,
	int baudRate,
	Parity parity,
	int dataBits,
	StopBits stopBits
)

Parameters

portName
Type: System.String

String. Required. Name of the port to open.

baudRate
Type: System.Int32

Integer. Baud rate of the port.

parity
Type: System.IO.Ports.Parity

Parity. Parity of the port.

dataBits
Type: System.Int32

Integer. Data-bit setting of the port.

stopBits
Type: System.IO.Ports.StopBits

StopBits. Stop-bit setting of the port.

Return Value

Type: System.IO.Ports.SerialPort
An open SerialPort object, configured with the supplied arguments.

ExceptionCondition
ArgumentNullException

portName is Nothing or an empty string.

ArgumentException

baudRate is less than or equal to zero.

ArgumentException

dataBits is less than or equal to zero.

InvalidEnumArgumentException

parity is not one of the Parity enumeration values.

InvalidEnumArgumentException

stopBits is not one of the StopBits enumeration values.

The My.Computer.Ports.OpenSerialPort method creates and opens a SerialPort object. The arguments to the OpenSerialPort method determine the settings of the SerialPort object.

Your code should close the SerialPort object when it is finished using the object. You can use the Close method to close the object explicitly or the Using statement to close it implicitly. See the example in this topic for more information.

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

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

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 in Visual Basic.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft