Export (0) Print
Expand All

Ports Class

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

System.Object
  Microsoft.VisualBasic.Devices.Ports

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

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, Resources := HostProtectionResource.ExternalProcessMgmt)> _
Public Class Ports

The Ports type exposes the following members.

  NameDescription
Public methodPortsInitializes a new instance of the Ports class.
Top

  NameDescription
Public propertySerialPortNamesGets a collection of the names of the serial ports on the computer.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOpenSerialPort(String)Creates and opens a SerialPort object.
Public methodOpenSerialPort(String, Int32)Creates and opens a SerialPort object.
Public methodOpenSerialPort(String, Int32, Parity)Creates and opens a SerialPort object.
Public methodOpenSerialPort(String, Int32, Parity, Int32)Creates and opens a SerialPort object.
Public methodOpenSerialPort(String, Int32, Parity, Int32, StopBits)Creates and opens a SerialPort object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Resources. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft