Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) メソッド

定義

非同期の読み込み動作を開始します。 (代わりに、ReadAsync(Byte[], Int32, Int32) の使用を検討してください。)

public:
 virtual IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);
public virtual IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback? callback, object? state);
public virtual IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object state);
public virtual IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object? state);
abstract member BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overridable Function BeginRead (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult

パラメーター

buffer
Byte[]

データを読み込むバッファー。

offset
Int32

ストリームから読み込んだデータの書き込み開始位置を示す buffer 内のバイト オフセット。

count
Int32

読み取る最大バイト数。

callback
AsyncCallback

読み取り完了時に呼び出されるオプションの非同期コールバック。

state
Object

この特定の非同期読み取り要求を他の要求と区別するために使用するユーザー指定のオブジェクト。

戻り値

IAsyncResult

非同期の読み込みを表す IAsyncResult。まだ保留状態の場合もあります。

例外

ストリームの末尾を越えて非同期の読み込みを実行しようとしました。または、ディスク エラーが発生しました。

1 つ以上の引数が無効です。

ストリームが閉じた後でメソッドが呼び出されました。

現在の Stream 実装は、読み取り操作をサポートしていません。

注釈

.NET Framework 4 およびそれ以前のバージョンで非同期 I/O 操作を実装するには、 BeginReadEndRead などのメソッドを使用する必要があります。 これらのメソッドは、従来のコードをサポートするために .NET Framework 4.5 で引き続き使用できますが、非同期 I/O 操作をより簡単に実装するのに役立つ 、WriteAsync、、FlushAsyncCopyToAsync、などのReadAsync新しい非同期メソッド。

ストリームに対する既定の BeginRead 実装では、メソッドが Read 同期的に呼び出されます。つまり Read 、一部のストリームでブロックされる可能性があります。 ただし、インスタンスが非同期で開かれている場合は、非同期操作などのFileStream``NetworkStreamクラスのインスタンスが完全にサポートされます。 したがって、呼び出し BeginRead はそれらのストリームでブロックされません。 (たとえば、非同期デリゲートを使用して) オーバーライド BeginRead して、非同期動作を提供できます。

ストリームの IAsyncResult メソッドに戻り値を EndRead 渡して、読み取られたバイト数を確認し、読み取りに使用されるオペレーティング システム リソースを解放します。 EndRead を呼び出すたびに 1 回呼び出す BeginRead必要があります。 これを行うには、呼び出 BeginRead したコードと同じコードを使用するか、渡された BeginReadコールバックで実行します。

ストリーム内の現在の位置は、I/O 操作が完了したときではなく、非同期の読み取りまたは書き込みが発行されたときに更新されます。

同時に複数の非同期要求を実行すると、要求の完了順序が不明になります。

プロパティを使用して、 CanRead 現在のインスタンスが読み取りをサポートしているかどうかを判断します。

ストリームが閉じているか、無効な引数を渡した場合、例外はすぐにからスローされます BeginRead。 非同期読み取り要求中に発生するエラー (I/O 要求中のディスク障害など) は、スレッド プール スレッドで発生し、呼び出 EndReadし時に例外をスローします。

適用対象

こちらもご覧ください