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

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

ソース:

Stream.cs

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

public:
 virtual IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);

public virtual IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback? callback, object? state);

abstract member BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult

Public Overridable Function BeginWrite (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。まだ保留状態の場合もあります。

例外

IOException

ファイルの末尾を越えて非同期の書き込みを実行しようとしました。または、ディスク エラーが発生しました。

ArgumentException

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

ObjectDisposedException

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

NotSupportedException

現在の Stream 実装は、書き込み操作をサポートしていません。

注釈

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

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

現在の IAsyncResult メソッドによって返された を に EndWrite 渡して、書き込みが完了し、リソースが適切に解放されるようにします。 EndWrite の呼び出しごとに 1 回呼び出す BeginWrite必要があります。 これを行うには、 を呼び出 BeginWrite したのと同じコードを使用するか、 に BeginWrite渡されたコールバックでを使用します。 非同期書き込み中にエラーが発生した場合、このメソッドによって返される をIAsyncResult使用して が呼び出されるまでEndWrite例外はスローされません。

ストリームが書き込み可能な場合、ストリームの末尾に書き込みを行うと、ストリームが展開されます。

ストリーム内の現在位置は、I/O 操作が完了したときではなく、非同期の読み取りまたは書き込みを発行すると更新されます。 複数の同時非同期要求によって、要求完了順序が不確実になります。

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

ストリームが閉じているか、無効な引数を渡すと、 から BeginWrite例外が直ちにスローされます。 非同期書き込み要求中に発生するエラー (I/O 要求中のディスク障害など) は、スレッド プール スレッドで発生し、 を呼び出 EndWriteすときに例外をスローします。

こちらもご覧ください

• EndWrite(IAsyncResult)
• CanWrite
• ファイルおよびストリーム入出力
• 方法: ファイルからのテキストの読み取り
• 方法: テキストのファイルへの書き込み
• 非同期ファイル I/O