TextReader.Read メソッド

定義

テキスト リーダーからデータを読み取ります。

オーバーロード

Read()

テキスト リーダーから次の文字を読み取り、1 文字分だけ文字位置を進めます。

Read(Span<Char>)

現在のリーダーから文字を読み取り、指定したバッファーにそのデータを書き込みます。

Read(Char[], Int32, Int32)

指定した最大文字数を現在のリーダーから読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。

Read()

ソース:
TextReader.cs
ソース:
TextReader.cs
ソース:
TextReader.cs

テキスト リーダーから次の文字を読み取り、1 文字分だけ文字位置を進めます。

public:
 virtual int Read();
public virtual int Read ();
abstract member Read : unit -> int
override this.Read : unit -> int
Public Overridable Function Read () As Integer

戻り値

テキスト リーダーからの次の文字。それ以上読み取り可能な文字がない場合は -1。 既定の実装では、-1 が返されます。

例外

TextReader が閉じています。

I/O エラーが発生します。

注釈

TextReader クラスは抽象クラスです。 そのため、コードでそれをインスタンス化することはありません。 メソッドの使用 Read 例については、 メソッドを StreamReader.Read 参照してください。

こちらもご覧ください

適用対象

Read(Span<Char>)

ソース:
TextReader.cs
ソース:
TextReader.cs
ソース:
TextReader.cs

現在のリーダーから文字を読み取り、指定したバッファーにそのデータを書き込みます。

public:
 virtual int Read(Span<char> buffer);
public virtual int Read (Span<char> buffer);
abstract member Read : Span<char> -> int
override this.Read : Span<char> -> int
Public Overridable Function Read (buffer As Span(Of Char)) As Integer

パラメーター

buffer
Span<Char>

このメソッドから制御が戻るときに、指定した文字のスパンが現在のソースから読み取られた文字に置き換えられます。

戻り値

読み取られた文字数。 この数値は、リーダー内に使用できるデータがあるかどうかに応じて、buffer の長さより小さいか等しくなります。 読み取り対象の文字がない場合にこのメソッドを呼び出すと、0 (ゼロ) が返されます。

例外

buffernullです。

ストリームから読み取った文字数が、buffer の長さを超えています。

適用対象

Read(Char[], Int32, Int32)

ソース:
TextReader.cs
ソース:
TextReader.cs
ソース:
TextReader.cs

指定した最大文字数を現在のリーダーから読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。

public:
 virtual int Read(cli::array <char> ^ buffer, int index, int count);
public virtual int Read (char[] buffer, int index, int count);
abstract member Read : char[] * int * int -> int
override this.Read : char[] * int * int -> int
Public Overridable Function Read (buffer As Char(), index As Integer, count As Integer) As Integer

パラメーター

buffer
Char[]

このメソッドが戻るとき、指定した文字配列の index から (index + count - 1) までの値が、現在のソースから読み取られた文字に置き換えられます。

index
Int32

書き込みを開始する buffer 内の位置。

count
Int32

読み取り対象の最大文字数。 指定された文字数をバッファーに読み取る前にリーダーの末尾に到達した場合、メソッドは制御を返します。

戻り値

読み取られた文字数。 この数値は、リーダー内に使用できるデータがあるかどうかによって異なりますが、count 以下の数値になります。 読み取り対象の文字がない場合にこのメソッドを呼び出すと、0 (ゼロ) が返されます。

例外

buffernullです。

バッファーの長さから index を引いた値が count 未満です。

index または count が負の値です。

TextReader が閉じています。

I/O エラーが発生します。

注釈

このメソッドは、いずれかの count 文字が読み取られた後、またはファイルの末尾に達した後に を返します。 ReadBlock は、このメソッドのブロック バージョンです。

TextReader クラスは抽象クラスです。 そのため、コードでそれをインスタンス化することはありません。 メソッドの使用 Read 例については、 メソッドを StreamReader.Read 参照してください。

こちらもご覧ください

適用対象