Ports.OpenSerialPort Method

Definition

Namespace:

Microsoft.VisualBasic.Devices

Assembly:

Microsoft.VisualBasic.dll

Creates and opens a SerialPort object.

Overloads

OpenSerialPort(String)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32, Parity)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32, Parity, Int32)	Creates and opens a SerialPort object.
OpenSerialPort(String, Int32, Parity, Int32, StopBits)	Creates and opens a SerialPort object.

OpenSerialPort(String)

Creates and opens a SerialPort object.

public:
 System::IO::Ports::SerialPort ^ OpenSerialPort(System::String ^ portName);

public System.IO.Ports.SerialPort OpenSerialPort (string portName);

member this.OpenSerialPort : string -> System.IO.Ports.SerialPort

Public Function OpenSerialPort (portName As String) As SerialPort

Parameters

portName

String

String. Required. Name of the port to open.

Returns

SerialPort

An open SerialPort object, configured with the supplied arguments.

Exceptions

ArgumentNullException

portName is Nothing or an empty string.

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.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.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From 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

See also

• SerialPortNames
• Parity
• StopBits
• SerialPort
• Objects (Visual Basic)
• How to: Dial Modems Attached to Serial Ports in Visual Basic
• How to: Send Strings to Serial Ports in Visual Basic
• How to: Receive Strings From Serial Ports in Visual Basic
• Using Statement (Visual Basic)

OpenSerialPort(String, Int32)

Creates and opens a SerialPort object.

public:
 System::IO::Ports::SerialPort ^ OpenSerialPort(System::String ^ portName, int baudRate);

public System.IO.Ports.SerialPort OpenSerialPort (string portName, int baudRate);

member this.OpenSerialPort : string * int -> System.IO.Ports.SerialPort

Public Function OpenSerialPort (portName As String, baudRate As Integer) As SerialPort

Parameters

portName

String

String. Required. Name of the port to open.

baudRate

Int32

Integer. Baud rate of the port.

Returns

SerialPort

An open SerialPort object, configured with the supplied arguments.

Exceptions

ArgumentNullException

portName is Nothing or an empty string.

ArgumentException

baudRate is less than or equal to zero.

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.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.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From 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

See also

• SerialPortNames
• Parity
• StopBits
• SerialPort
• Objects (Visual Basic)
• How to: Dial Modems Attached to Serial Ports in Visual Basic
• How to: Send Strings to Serial Ports in Visual Basic
• How to: Receive Strings From Serial Ports in Visual Basic
• Using Statement (Visual Basic)

OpenSerialPort(String, Int32, Parity)

Creates and opens a SerialPort object.

public:
 System::IO::Ports::SerialPort ^ OpenSerialPort(System::String ^ portName, int baudRate, System::IO::Ports::Parity parity);

public System.IO.Ports.SerialPort OpenSerialPort (string portName, int baudRate, System.IO.Ports.Parity parity);

member this.OpenSerialPort : string * int * System.IO.Ports.Parity -> System.IO.Ports.SerialPort

Public Function OpenSerialPort (portName As String, baudRate As Integer, parity As Parity) As SerialPort

Parameters

portName

String

String. Required. Name of the port to open.

baudRate

Int32

Integer. Baud rate of the port.

parity

Parity

Parity. Parity of the port.

Returns

SerialPort

An open SerialPort object, configured with the supplied arguments.

Exceptions

ArgumentNullException

portName is Nothing or an empty string.

ArgumentException

baudRate is less than or equal to zero.

InvalidEnumArgumentException

parity is not one of the Parity enumeration values.

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.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.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From 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

See also

• SerialPortNames
• Parity
• StopBits
• SerialPort
• Objects (Visual Basic)
• How to: Dial Modems Attached to Serial Ports in Visual Basic
• How to: Send Strings to Serial Ports in Visual Basic
• How to: Receive Strings From Serial Ports in Visual Basic
• Using Statement (Visual Basic)

OpenSerialPort(String, Int32, Parity, Int32)

Creates and opens a SerialPort object.

public:
 System::IO::Ports::SerialPort ^ OpenSerialPort(System::String ^ portName, int baudRate, System::IO::Ports::Parity parity, int dataBits);

public System.IO.Ports.SerialPort OpenSerialPort (string portName, int baudRate, System.IO.Ports.Parity parity, int dataBits);

member this.OpenSerialPort : string * int * System.IO.Ports.Parity * int -> System.IO.Ports.SerialPort

Public Function OpenSerialPort (portName As String, baudRate As Integer, parity As Parity, dataBits As Integer) As SerialPort

Parameters

portName

String

String. Required. Name of the port to open.

baudRate

Int32

Integer. Baud rate of the port.

parity

Parity

Parity. Parity of the port.

dataBits

Int32

Integer. Data-bit setting of the port.

Returns

SerialPort

An open SerialPort object, configured with the supplied arguments.

Exceptions

ArgumentNullException

portName is Nothing or an empty string.

ArgumentException

dataBits is less than or equal to zero.

InvalidEnumArgumentException

parity is not one of the Parity enumeration values.

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.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.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From 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

See also

• SerialPortNames
• Parity
• StopBits
• SerialPort
• Objects (Visual Basic)
• How to: Dial Modems Attached to Serial Ports in Visual Basic
• How to: Send Strings to Serial Ports in Visual Basic
• How to: Receive Strings From Serial Ports in Visual Basic
• Using Statement (Visual Basic)

OpenSerialPort(String, Int32, Parity, Int32, StopBits)

Creates and opens a SerialPort object.

public:
 System::IO::Ports::SerialPort ^ OpenSerialPort(System::String ^ portName, int baudRate, System::IO::Ports::Parity parity, int dataBits, System::IO::Ports::StopBits stopBits);

public System.IO.Ports.SerialPort OpenSerialPort (string portName, int baudRate, System.IO.Ports.Parity parity, int dataBits, System.IO.Ports.StopBits stopBits);

member this.OpenSerialPort : string * int * System.IO.Ports.Parity * int * System.IO.Ports.StopBits -> System.IO.Ports.SerialPort

Public Function OpenSerialPort (portName As String, baudRate As Integer, parity As Parity, dataBits As Integer, stopBits As StopBits) As SerialPort

Parameters

portName

String

String. Required. Name of the port to open.

baudRate

Int32

Integer. Baud rate of the port.

parity

Parity

Parity. Parity of the port.

dataBits

Int32

Integer. Data-bit setting of the port.

stopBits

StopBits

StopBits. Stop-bit setting of the port.

Returns

SerialPort

An open SerialPort object, configured with the supplied arguments.

Exceptions

ArgumentNullException

portName is Nothing or an empty string.

ArgumentException

dataBits is less than or equal to zero.

InvalidEnumArgumentException

stopBits is not one of the StopBits enumeration values.

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.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.

To	See
Dial a modem attached to a serial port	How to: Dial Modems Attached to Serial Ports
Send a string to serial port	How to: Send Strings to Serial Ports
Receive strings from a serial port	How to: Receive Strings From 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

See also

• SerialPortNames
• Parity
• StopBits
• SerialPort
• Objects (Visual Basic)
• How to: Dial Modems Attached to Serial Ports in Visual Basic
• How to: Send Strings to Serial Ports in Visual Basic
• How to: Receive Strings From Serial Ports in Visual Basic
• Using Statement (Visual Basic)