SerialPort.ReadExisting メソッド

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

SerialPort.ReadExisting メソッド

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

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

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

Visual Basic (宣言)

Public Function ReadExisting As
 String

Visual Basic (使用法)

Dim instance As SerialPort
Dim returnValue As String

returnValue = instance.ReadExisting

C#

public string ReadExisting ()

C++

public:
String^ ReadExisting ()

J#

public String ReadExisting ()

JScript

public function ReadExisting () : String

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

例外

例外の種類	条件
InvalidOperationException	指定したポートが開いていません。

解説

このメソッドは、ストリームと SerialPort オブジェクトの入力バッファの内容を文字列として返します。このメソッドでは、タイムアウトは使用しません。このメソッドは、内部バッファに後続の先行バイトを残すことができるため、BytesToRead 値は 0 より大きくなります。

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

メモ
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 名前空間