TextReader.ReadAsync メソッド

定義

オーバーロード

ReadAsync(Char[], Int32, Int32)

指定した最大文字数を現在のテキスト リーダーから非同期に読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

ReadAsync(Memory<Char>, CancellationToken)

現在のストリームからメモリ ブロックに文字を非同期に読み取ります。Asynchronously reads the characters from the current stream into a memory block.

ReadAsync(Char[], Int32, Int32)

指定した最大文字数を現在のテキスト リーダーから非同期に読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

パラメーター

buffer
Char[]

このメソッドが戻るとき、指定した文字配列の index から (index + count - 1) までの値が、現在のソースから読み取られた文字に置き換えられます。When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

書き込みを開始する buffer 内の位置。The position in buffer at which to begin writing.

count
Int32

読み取り対象の最大文字数。The maximum number of characters to read. 指定された文字数をバッファーに読み取る前にテキストの末尾に到達した場合は、現在のメソッドが返ります。If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

戻り値

Task<Int32>

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. TResult パラメーターの値には、バッファーに読み込まれるバイトの合計数が含まれます。The value of the TResult parameter contains the total number of bytes read into the buffer. 現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、テキストの末尾に到達した場合は 0 になることがあります。The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

属性

例外

buffernullです。buffer is null.

index または count が負の値です。index or count is negative.

indexcount の合計が、バッファーの長さよりも大きいです。The sum of index and count is larger than the buffer length.

テキスト リーダーは破棄されています。The text reader has been disposed.

リーダーは、前の読み取り操作によって現在使用されています。The reader is currently in use by a previous read operation.

注釈

パラメーターで指定された文字数が count 読み取られるか、ファイルの末尾に到達すると、タスクが完了します。The task completes after either the number of characters specified by the count parameter are read or the end of the file is reached.

TextReader クラスは抽象クラスです。The TextReader class is an abstract class. そのため、コードでそれをインスタンス化することはありません。Therefore, you do not instantiate it in your code. メソッドの使用例については、 ReadAsync メソッドを参照してください StreamReader.ReadAsyncFor an example of using the ReadAsync method, see the StreamReader.ReadAsync method.

こちらもご覧ください

適用対象

ReadAsync(Memory<Char>, CancellationToken)

現在のストリームからメモリ ブロックに文字を非同期に読み取ります。Asynchronously reads the characters from the current stream into a memory block.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer
Memory<Char>

このメソッドから制御が戻るときに、指定した文字のメモリ ブロックが現在のソースから読み取られた文字に置き換えられます。When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

ValueTask<Int32>

非同期の読み取り操作を表す値タスク。A value task that represents the asynchronous read operation. 型パラメーターの値には、読み取られた文字数が格納されます。ストリームの末尾でデータが読み取られなかった場合は 0 です。The value of the type parameter contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. この数値は、ストリーム内に使用できるデータがあるかどうかによって異なりますが、buffer の長さ以下の数値になります。The number will be less than or equal to the buffer length, depending on whether the data is available within the stream.

適用対象