Stream.BeginRead メソッド

.NET Framework クラス ライブラリ リファレンス

Stream.BeginRead メソッド

非同期の読み込み動作を開始します。

名前空間: System.IO
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 BeginRead ( _
    buffer As Byte(), _
    offset As Integer, _
    count As Integer, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

Visual Basic (使用法)

Dim instance As Stream
Dim buffer As Byte()
Dim offset As Integer
Dim count As Integer
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRead(buffer, offset, count, callback, state)

C#

public virtual IAsyncResult BeginRead (
    byte[] buffer,
    int offset,
    int count,
    AsyncCallback callback,
    Object state
)

C++

public:
virtual IAsyncResult^ BeginRead (
    array<unsigned char>^ buffer, 
    int offset, 
    int count, 
    AsyncCallback^ callback, 
    Object^ state
)

J#

public IAsyncResult BeginRead (
    byte[] buffer, 
    int offset, 
    int count, 
    AsyncCallback callback, 
    Object state
)

JScript

public function BeginRead (
    buffer : byte[], 
    offset : int, 
    count : int, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

パラメータ

buffer

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

offset

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

count

読み取る最大バイト数。

callback

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

state

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

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

例外

例外の種類	条件
IOException	ストリームの末尾を越えて非同期の読み込みを実行しようとしました。または、ディスク エラーが発生しました。
ArgumentException	1 つ以上の引数が無効です。
ObjectDisposedException	ストリームが閉じられた後でメソッドが呼び出されました。
NotSupportedException	現在の Stream 実装は、読み取り操作をサポートしていません。

解説

ファイルの作成およびテキストのファイルへの書き込みの例については、「方法 : ファイルにテキストを書き込む」を参照してください。ファイルからのテキストの読み取りの例については、「方法 : ファイルからテキストを読み取る」を参照してください。バイナリ ファイルの読み取りおよび書き込みの例については、「方法 : 新しく作成されたデータ ファイルに対して読み書きする」を参照してください。非同期ファイル I/O の例については、「非同期ファイル I/O」を参照してください。

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

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

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

複数の非同期要求を同時に実行した場合、要求の完了順序は不定です。

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

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Stream クラス
Stream メンバ
System.IO 名前空間
その他の技術情報
ファイルおよびストリーム入出力
方法 : ファイルからテキストを読み取る
方法 : ファイルにテキストを書き込む
非同期ファイル I/O