SerialPort.ReadTo メソッド

.NET Framework クラス ライブラリ リファレンス

SerialPort.ReadTo メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

入力バッファ内の指定した value まで文字列を読み取ります。

名前空間: System.IO.Ports
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Function ReadTo ( _
    value As String _
) As String

Visual Basic (使用法)

Dim instance As SerialPort
Dim value As String
Dim returnValue As String

returnValue = instance.ReadTo(value)

C#

public string ReadTo (
    string value
)

C++

public:
String^ ReadTo (
    String^ value
)

J#

public String ReadTo (
    String value
)

JScript

public function ReadTo (
    value : String
) : String

パラメータ

value

読み取り操作を停止する場所を示す値。

戻り値
指定した value までの入力バッファの内容。

例外

例外の種類	条件
ArgumentException	value パラメータの長さが 0 です。
ArgumentNullException	value パラメータが null 参照 (Visual Basic では Nothing) です。
InvalidOperationException	指定したポートが開いていません。
TimeoutException	タイムアウト時間内に操作が完了しませんでした。

解説

このメソッドは、指定した value までの文字列を読み取ります。返される文字列に value が含まれていない場合、value は入力バッファから削除されます。

ストリームからのテキストの読み取りとバイナリ データの読み取りを切り替える必要がある場合は、手動でのバイトの読み取りやデータのデコードなど、テキストとバイナリ データの境界を詳細に定義したプロトコルを選択します。

メモ
SerialPort クラスはデータをバッファに格納しますが、BaseStream プロパティに格納されたストリームはデータをバッファに格納しないため、読み取ることができるバイト数がこの 2 つの間で異なる場合があります。BytesToRead プロパティは、読み取るバイトが存在することを示すことができますが、バイトは SerialPort クラスにバッファされているため、BaseStream プロパティに格納されたストリームからはこれらのバイトにアクセスできない場合があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
SerialPort クラス
SerialPort メンバ
System.IO.Ports 名前空間