SerialPort.ReadExisting メソッド

定義

名前空間:

System.IO.Ports

アセンブリ:

System.IO.Ports.dll

パッケージ:

System.IO.Ports v8.0.0

ソース:

SerialPort.cs

ストリームと SerialPort オブジェクトの入力バッファーの両方で、エンコーディングに基づいて、即座に使用できるすべてのバイトを読み取ります。

public:
 System::String ^ ReadExisting();

public string ReadExisting ();

member this.ReadExisting : unit -> string

Public Function ReadExisting () As String

戻り値

String

ストリームと SerialPort オブジェクトの入力バッファーの内容。

例外

InvalidOperationException

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

注釈

このメソッドは、ストリームの内容とオブジェクトの内部バッファーを SerialPort 文字列として返します。 このメソッドでは、タイムアウトは使用されません。このメソッドは、内部バッファーに末尾のリード バイトを残すことがあり、値が BytesToRead 0 より大きくなることに注意してください。

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

注意

クラスは SerialPort データをバッファーしますが、 プロパティに SerialPort.BaseStream 含まれるストリーム オブジェクトはバッファーに格納しません。 したがって、オブジェクトとストリーム オブジェクトは、 SerialPort 読み取り可能なバイト数によって異なる場合があります。 バイトがオブジェクトに SerialPort バッファーされると、 プロパティの BytesToRead 値にこれらのバイトが含まれます。ただし、これらのバイトは、 プロパティに含まれる BaseStream ストリームからアクセスできない可能性があります。