My.Computer.Ports.OpenSerialPort, méthode

Article
08/21/2008

Mise à jour : novembre 2007

Crée et ouvre un objet SerialPort.

' Usage
Dim value As System.IO.Ports.SerialPort = My.Computer.Ports.OpenSerialPort(portName)
Dim value As System.IO.Ports.SerialPort = My.Computer.Ports.OpenSerialPort(portName ,baudRate)
Dim value As System.IO.Ports.SerialPort = My.Computer.Ports.OpenSerialPort(portName ,baudRate ,parity)
Dim value As System.IO.Ports.SerialPort = My.Computer.Ports.OpenSerialPort(portName ,baudRate ,parity ,dataBits)
Dim value As System.IO.Ports.SerialPort = My.Computer.Ports.OpenSerialPort(portName ,baudRate ,parity ,dataBits ,stopBits)
' Declaration
Public Function OpenSerialPort( _
   ByVal portName As String _
) As System.IO.Ports.SerialPort
' -or-
Public Function OpenSerialPort( _
   ByVal portName As String, _
   ByVal baudRate As Integer _
) As System.IO.Ports.SerialPort
' -or-
Public Function OpenSerialPort( _
   ByVal portName As String, _
   ByVal baudRate As Integer, _
   ByVal parity As System.IO.Ports.Parity _
) As System.IO.Ports.SerialPort
' -or-
Public Function OpenSerialPort( _
   ByVal portName As String, _
   ByVal baudRate As Integer, _
   ByVal parity As System.IO.Ports.Parity, _
   ByVal dataBits As Integer _
) As System.IO.Ports.SerialPort
' -or-
Public Function OpenSerialPort( _
   ByVal portName As String, _
   ByVal baudRate As Integer, _
   ByVal parity As System.IO.Ports.Parity, _
   ByVal dataBits As Integer, _
   ByVal stopBits As System.IO.Ports.StopBits _
) As System.IO.Ports.SerialPort

Paramètres

portName
String. Requis. Nom du port à ouvrir.
baudRate
Integer. Vitesse en bauds du port.
parity
Parity. Parité du port.
dataBits
Integer. Paramètre de bit des données du port.
stopBits
StopBits. Paramètre de bit d'arrêt du port.

Valeur de retour

Objet SerialPort ouvert, configuré avec les arguments fournis.

Exceptions

Les conditions ci-dessous peuvent générer une exception :

l'argument portName a la valeur Nothing ou est une chaîne vide (ArgumentNullException) ;
l'argument baudRate ou dataBits est nul ou négatif (ArgumentException) ;
le type d'argument parity ne fait pas partie des valeurs de l'énumération Parity (InvalidEnumArgumentException) ;
le type d'argument stopBits ne fait pas partie des valeurs de l'énumération StopBits (InvalidEnumArgumentException).

Notes

La méthode My.Computer.Ports.OpenSerialPort crée et ouvre un objet SerialPort. Les arguments de la méthode OpenSerialPort déterminent les paramètres de l'objet SerialPort.

Votre code doit fermer l'objet SerialPort lorsqu'il a fini de l'utiliser. Vous pouvez utiliser la méthode Close pour fermer l'objet explicitement ou l'instruction Using pour le fermer implicitement. Pour plus d'informations, consultez l'exemple de cette rubrique.

Tâches

Le tableau suivant répertorie des exemples de tâches impliquant la méthode My.Computer.Ports.OpenSerialPort.

Pour	Reportez-vous à
Utiliser un modem rattaché à un port série	Comment : passer des appels avec des modems attachés aux ports série dans Visual Basic
Envoyer une chaîne à un port série	Comment : envoyer des chaînes aux ports série dans Visual Basic
Recevoir des chaînes d'un port série	Comment : recevoir des chaînes des ports série dans Visual Basic

Exemple

Cet exemple montre comment envoyer des chaînes au port série COM1 de l'ordinateur.

Le bloc Using permet à l'application de fermer le port série même s'il génère une exception. Tout le code qui manipule le port série doit apparaître dans ce bloc ou dans un bloc Try...Catch...Finally avec un appel pour utiliser la méthode Close.

La méthode WriteLine envoie les données au port série.

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

Pour plus d'informations, consultez Comment : envoyer des chaînes aux ports série dans Visual Basic.

Configuration requise

Espace de noms :Microsoft.VisualBasic.Devices

Classe :Ports

Assembly : bibliothèque Runtime Visual Basic (dans Microsoft.VisualBasic.dll)

Disponibilité par type de projet

Type de projet	Disponible
Application Windows	Oui
Bibliothèque de classes	Oui
Application console	Oui
Bibliothèque de contrôles Windows	Oui
Bibliothèque de contrôles Web	Non
Service Windows	Oui
Site Web	Non