SslStream.ReadAsync メソッド

定義

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken)

このストリームからデータを非同期的に読み取り、それを指定されたメモリ範囲に格納します。Asynchronously reads data from this stream and stores it in the specified memory range.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

このストリームからデータを非同期的に読み取り、それをバイト配列の指定の範囲に格納します。Asynchronously reads data from this stream and stores it in the specified range of a byte array.

ReadAsync(Memory<Byte>, CancellationToken)

このストリームからデータを非同期的に読み取り、それを指定されたメモリ範囲に格納します。Asynchronously reads data from this stream and stores it in the specified memory range.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer
Memory<Byte>

このストリームから読み取ったバイトを受け取るバッファー。The buffer that receives the bytes read from this stream.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests.

戻り値

ValueTask<Int32>

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. その Result プロパティの値には、buffer に読み取られたバイトの合計数が含まれます。The value of its Result property contains the total number of bytes read into buffer. 読み取るデータがこれ以上存在しない場合は 0 を返します。When there is no more data to be read, returns 0.

例外

認証が行われていません。Authentication has not occurred.

読み取り操作に失敗しました。The read operation failed. 内部例外が存在する場合は、チェックしてエラーの原因を確認してください。Check the inner exception, if it is present, to determine the cause of the failure.

既に実行中の読み取り操作が存在します。There is already a read operation in progress.

このオブジェクトは閉じられました。This object has been closed.

注釈

このメソッドは、で使用できるデータの量を読み取り buffer ます。This method reads as much data as is available into the buffer.

複数の同時読み取り操作を実行することはできません。You cannot perform multiple simultaneous read operations.

が正常に認証されるまで、このメソッドを呼び出すことはできません。You cannot call this method until you have successfully authenticated.

適用対象

ReadAsync(Byte[], Int32, Int32, CancellationToken)

このストリームからデータを非同期的に読み取り、それをバイト配列の指定の範囲に格納します。Asynchronously reads data from this stream and stores it in the specified range of a byte array.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

パラメーター

buffer
Byte[]

このストリームから読み取ったバイトを受け取るバッファー。The buffer that receives the bytes read from this stream.

offset
Int32

このストリームから読み取ったデータの格納を開始する位置を示す、buffer 内のインデックス番号が 0 から始まる位置。The zero-based location in buffer at which to begin storing the data read from this stream.

count
Int32

このストリームから読み取られた最大バイト数。The maximum number of bytes to read from this stream.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests.

戻り値

Task<Int32>

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. その Result プロパティの値には、buffer に読み取られたバイトの合計数が含まれます。The value of its Result property contains the total number of bytes read into buffer. 読み取るデータがこれ以上存在しない場合は 0 を返します。When there is no more data to be read, returns 0.

例外

buffernullです。buffer is null.

offset が 0 未満です。offset is less than 0.

または-or- count が 0 未満です。count is less than 0.

または-or- count が、buffer から offset を引いた長さを超えています。count is greater than the length of buffer minus offset.

認証が行われていません。Authentication has not occurred.

読み取り操作に失敗しました。The read operation failed. 内部例外が存在する場合は、チェックしてエラーの原因を確認してください。Check the inner exception, if it is present, to determine the cause of the failure.

既に実行中の読み取り操作が存在します。There is already a read operation in progress.

このオブジェクトは閉じられました。This object has been closed.

注釈

メソッドは、ストリームから最大バイトを読み取り、から count 始まるに格納し buffer offset ます。The method reads a maximum of count bytes from the stream and stores them in buffer beginning at offset.

複数の同時読み取り操作を実行することはできません。You cannot perform multiple simultaneous read operations.

が正常に認証されるまで、このメソッドを呼び出すことはできません。You cannot call this method until you have successfully authenticated.

適用対象