SerialPort.ReadTo(String) メソッド

定義

名前空間:

System.IO.Ports

アセンブリ:

System.IO.Ports.dll

パッケージ:

System.IO.Ports v8.0.0

ソース:

SerialPort.cs

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

public:
 System::String ^ ReadTo(System::String ^ value);

public string ReadTo (string value);

member this.ReadTo : string -> string

Public Function ReadTo (value As String) As String

パラメーター

value

String

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

戻り値

String

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

例外

ArgumentException

value パラメーターの長さが 0 です。

ArgumentNullException

value パラメーターが null です。

InvalidOperationException

指定したポートが開いていません。

TimeoutException

タイムアウト時間内に操作が完了しませんでした。

注釈

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

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

注意

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