My.Computer.Ports.OpenSerialPort メソッド

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

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

パラメータ

portName
String です。必ず指定します。開くポートの名前を指定します。
baudRate
Integer です。ポートのボーレートを指定します。
parity
Parity です。ポートのパリティを指定します。
dataBits
Integer です。ポートのデータビット設定を指定します。
stopBits
StopBits です。ポートのストップビット設定を指定します。

戻り値

指定の引数に基づいて設定された、開かれた SerialPort オブジェクト

例外

例外を引き起こす可能性のある状態を次に示します。

portName 引数が Nothing または空の文字列である (ArgumentNullException)。
baudRate 引数または dataBits 引数が 0 または負数である (ArgumentException)。
parity 引数の型が Parity 列挙値のどれでもない (InvalidEnumArgumentException)。
stopBits 引数の型が StopBits 列挙値のどれでもない (InvalidEnumArgumentException)。

解説

My.Computer.Ports.OpenSerialPort メソッドは、SerialPort オブジェクトを作成して開きます。OpenSerialPort メソッドに渡した引数により、SerialPort オブジェクトの設定が決まります。

SerialPort オブジェクトを使用し終わったら、このオブジェクトを閉じる必要があります。このオブジェクトを明示的に閉じるには Close メソッドを使用し、暗黙的に閉じるには Using ステートメントを使用します。詳細については、このページの例を参照してください。

処理手順

My.Computer.Ports.OpenSerialPort メソッドに関連するタスクの例を次の表に示します。

目的	参照項目
シリアルポートに接続されているモデムをダイヤルする	方法 : Visual Basic で、シリアルポートに接続されているモデムをダイヤルする
シリアルポートに文字列を送信する	方法 : Visual Basic でシリアルポートに文字列を送信する
シリアルポートから文字列を受信する	方法 : Visual Basic でシリアルポートから文字列を受信する

使用例

この例は、コンピュータの COM1 シリアルポートに文字列を送信する方法を示します。

Using ブロックを使用すると、例外が生成される場合でもアプリケーションでシリアルポートを閉じることができます。シリアルポートを操作するコードは、このブロック内に記述するか、Close メソッドの呼び出しを含んだ Try...Catch...Finally ブロック内に記述する必要があります。

WriteLine メソッドはシリアルポートにデータを送信します。

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

詳細については、「方法 : Visual Basic でシリアルポートに文字列を送信する」を参照してください。

必要条件

名前空間 : Microsoft.VisualBasic.Devices

クラス : Ports

アセンブリ : Visual Basic ランタイムライブラリ (Microsoft.VisualBasic.dll 内)

プロジェクトの種類ごとの可用性

プロジェクトの種類	可用性
Windows アプリケーション	可
クラスライブラリ	可
コンソールアプリケーション	可
Windows コントロールライブラリ	可
Web コントロールライブラリ	不可
Windows サービス	可
Web サイト	不可