FileStream.BeginRead メソッド
非同期の読み取りを開始します。
Overrides Public Function BeginRead( _
ByVal array() As Byte, _ ByVal offset As Integer, _ ByVal numBytes As Integer, _ ByVal userCallback As AsyncCallback, _ ByVal stateObject As Object _) As IAsyncResult
[C#]
public override IAsyncResult BeginRead(byte[] array,intoffset,intnumBytes,AsyncCallbackuserCallback,objectstateObject);
[C++]
public: IAsyncResult* BeginRead(unsigned chararray __gc[],intoffset,intnumBytes,AsyncCallback* userCallback,Object* stateObject);
[JScript]
public override function BeginRead(
array : Byte[],offset : int,numBytes : int,userCallback : AsyncCallback,stateObject : Object) : IAsyncResult;
パラメータ
- array
データを読み取るバッファ。 - offset
読み取りの開始位置を示す array 内のバイト オフセット。 - numBytes
読み取る最大バイト数。 - userCallback
非同期の読み取り操作が完了したときに呼び出されるメソッド。 - stateObject
この特定の非同期読み取り要求を他の要求と区別するために使用するユーザー指定のオブジェクト。
戻り値
非同期の読み取りを参照する IAsyncResult 。
例外
例外の種類 | 条件 |
---|---|
ArgumentException | 配列長から offset を差し引いた値が numBytes より小さい値です。 |
ArgumentNullException | array が null 参照 (Visual Basic では Nothing) です。 |
ArgumentOutOfRangeException | offset または numBytes が負の値です。 |
IOException | ファイルの末尾を越える位置で、非同期の読み取りを試行しました。 |
解説
FileStream には、同期 I/O と非同期 I/O の 2 種類の操作モードがあります。どちらも使用できる場合に、基になるオペレーティング システム リソースはいずれかのモードでのアクセスだけを許可することがあります。既定では、 FileStream は同期的にオペレーティング システム ハンドルを開きます。Windows では、これによって非同期メソッドの速度が遅くなります。非同期メソッドを使用する場合は、 FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean) コンストラクタを使用してください。
メモ 現在のインスタンスが読み取りをサポートしているかどうかを判断するには、 CanRead プロパティを使用します。詳細については、 CanRead のトピックを参照してください。
ストリームが閉じている場合、または無効な引数を渡した場合は、 BeginRead からすぐに例外がスローされます。I/O 要求中のディスク障害など、非同期読み取りの要求中に発生したエラーは、スレッドプールのスレッドで発生し、 EndRead を呼び出したときに可視になります。
メモ Windows では、64 KB 未満のすべての I/O 操作を同期的に実行した方がパフォーマンスが高くなります。非同期 I/O は、64 KB 未満のバッファ サイズでのパフォーマンスを低下させることがあります。
EndRead は、読み取られたバイト数を検出するために、この IAsyncResult と共に呼び出す必要があります。
複数の非同期要求を同時に実行した場合、要求の完了順序は不定です。
その他の一般的な I/O タスクまたは関連する I/O タスクの例を次の表に示します。
実行するタスク | 参考例があるトピック |
---|---|
テキスト ファイルを作成する。 | ファイルへのテキストの書き込み |
テキスト ファイルに書き込む。 | ファイルへのテキストの書き込み |
テキスト ファイルから読み取る。 | ファイルからのテキストの読み取り |
テキストをファイルに追加する。 | ログ ファイルのオープンと追加 |
ファイルの名前を変更、またはファイルを移動する。 | File.Move |
ファイルをコピーする。 | File.Copy |
ファイルのサイズを取得する。 | FileInfo.Length |
ファイルの属性を取得する。 | File.GetAttributes |
ファイルの属性を設定する。 | File.SetAttributes |
ファイルが存在するかどうかを判別する。 | File.Exists |
バイナリ ファイルから読み取る。 | 新しく作成したデータ ファイルの読み取りと書き込み |
バイナリ ファイルに書き込む。 | 新しく作成したデータ ファイルの読み取りと書き込み |
ディレクトリを作成する。 | Directory.CreateDirectory |
使用例
[Visual Basic, C#, C++] 次のコード例は System.IO.FileStream.FileStream4 の例の一部です。
Private Shared Sub EndWriteCallback(asyncResult As IAsyncResult)
Dim tempState As State = _
DirectCast(asyncResult.AsyncState, State)
Dim fStream As FileStream = tempState.FStream
fStream.EndWrite(asyncResult)
' Asynchronously read back the written data.
fStream.Position = 0
asyncResult = fStream.BeginRead( _
tempState.ReadArray, 0 , tempState.ReadArray.Length, _
AddressOf EndReadCallback, tempState)
' Concurrently do other work, such as
' logging the write operation.
End Sub
[C#]
static void EndWriteCallback(IAsyncResult asyncResult)
{
State tempState = (State)asyncResult.AsyncState;
FileStream fStream = tempState.FStream;
fStream.EndWrite(asyncResult);
// Asynchronously read back the written data.
fStream.Position = 0;
asyncResult = fStream.BeginRead(
tempState.ReadArray, 0 , tempState.ReadArray.Length,
new AsyncCallback(EndReadCallback), tempState);
// Concurrently do other work, such as
// logging the write operation.
}
[C++]
static void EndWriteCallback(IAsyncResult* asyncResult)
{
State* tempState =
dynamic_cast<State*>(asyncResult->AsyncState);
FileStream* fStream = tempState->FStream;
fStream->EndWrite(asyncResult);
// Asynchronously read back the written data.
fStream->Position = 0;
asyncResult = fStream->BeginRead(
tempState->ReadArray, 0 , tempState->ReadArray->Length,
new AsyncCallback(
0, &FStream::EndReadCallback), tempState);
// Concurrently do other work, such as
// logging the write operation.
}
};
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。
必要条件
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET, Common Language Infrastructure (CLI) Standard
参照
FileStream クラス | FileStream メンバ | System.IO 名前空間 | 入出力操作 | ファイルからのテキストの読み取り | ファイルへのテキストの書き込み | 非同期ファイル I/O