FileStream.EndRead メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

FileStream.EndRead メソッド

保留中の非同期読み取りが完了するまで待機します。

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

Visual Basic (宣言)

Public Overrides Function
 EndRead ( _
    asyncResult As IAsyncResult _
) As Integer

Visual Basic (使用法)

Dim instance As FileStream
Dim asyncResult As IAsyncResult
Dim returnValue As Integer

returnValue = instance.EndRead(asyncResult)

public override int EndRead (
    IAsyncResult asyncResult
)

C++

public:
virtual int EndRead (
    IAsyncResult^ asyncResult
) override

public int EndRead (
    IAsyncResult asyncResult
)

JScript

public override function EndRead (
    asyncResult : IAsyncResult
) : int

パラメータ

asyncResult: 待機する保留状態の非同期要求への参照。

戻り値
ストリームから読み込んだバイト数 (0 ～要求したバイト数の間の数値)。ストリームの末尾では 0 が返されるだけです。それ以外の場合は、少なくとも 1 バイトが読み込み可能になるまでブロックします。

例外

例外の種類	条件
ArgumentNullException	asyncResult が null 参照 (Visual Basic では Nothing) です。
ArgumentException	この IAsyncResult オブジェクトは、このクラスでの BeginRead を呼び出して作成されたオブジェクトではありません。
InvalidOperationException	EndRead が複数回呼び出されました。

解説

EndRead は、BeginRead を呼び出すたびに 1 回ずつ呼び出す必要があります。読み取りプロセスを終了できずに別の読み取りプロセスを開始すると、デッドロックなどの好ましくない動作が発生することがあります。

このメソッドは、EndRead をオーバーライドします。

EndRead は、BeginRead からの各 IAsyncResult ごとに 1 回ずつ呼び出すことができます。EndRead を呼び出すと、ストリームから読み込まれたバイト数が通知されます。EndRead は、I/O 操作が完了するまでブロックします。

その他の一般的な I/O タスクまたは関連する I/O タスクの例を次の表に示します。

実行するタスク	参考例があるトピック
テキストファイルを作成する。	方法 : ファイルにテキストを書き込む
テキストファイルに書き込む。	方法 : ファイルにテキストを書き込む
テキストファイルから読み取る。	方法 : ファイルからテキストを読み取る
テキストをファイルに追加する。	方法 : ログファイルを開いて情報を追加する File.AppendText FileInfo.AppendText
ファイルの名前を変更、またはファイルを移動する。	File.Move FileInfo.MoveTo
ファイルをコピーする。	File.Copy FileInfo.CopyTo
ファイルのサイズを取得する。	FileInfo.Length
ファイルの属性を取得する。	File.GetAttributes
ファイルの属性を設定する。	File.SetAttributes
ファイルが存在するかどうかを判別する。	File.Exists
バイナリファイルから読み取る。	方法 : 新しく作成されたデータファイルに対して読み書きする
バイナリファイルに書き込む。	方法 : 新しく作成されたデータファイルに対して読み書きする
ディレクトリを作成する。	Directory.CreateDirectory Directory.CreateDirectory

使用例

次のコード例は、FileStream(String,FileMode,FileAccess,FileShare,Int32,Boolean) コンストラクタの例の一部です。

Visual Basic

Private Shared Sub EndReadCallback(asyncResult
 As IAsyncResult)
     Dim tempState As State = _
         DirectCast(asyncResult.AsyncState, State)
     Dim readCount As Integer
 = _
         tempState.FStream.EndRead(asyncResult)

     Dim i As Integer =
 0
     While(i < readCount)
         If(tempState.ReadArray(i) <> tempState.WriteArray(i))
             Console.WriteLine("Error writing data.")
             tempState.FStream.Close()
             Return
         End If
         i += 1
     End While

     Console.WriteLine("The data was written to {0} and "
 & _
         "verified.", tempState.FStream.Name)
     tempState.FStream.Close()

     ' Signal the main thread that the verification is finished.
     tempState.ManualEvent.Set()
 End Sub

static void EndReadCallback(IAsyncResult asyncResult)
{
    State tempState = (State)asyncResult.AsyncState;
    int readCount = tempState.FStream.EndRead(asyncResult);

    int i = 0;
    while(i < readCount)
    {
        if(tempState.ReadArray[i] != tempState.WriteArray[i++])
        {
            Console.WriteLine("Error writing data.");
            tempState.FStream.Close();
            return;
        }
    }
    Console.WriteLine("The data was written to {0} and verified.",
        tempState.FStream.Name);
    tempState.FStream.Close();

    // Signal the main thread that the verification is finished.
    tempState.ManualEvent.Set();
}

C++

   static void EndReadCallback( IAsyncResult^
 asyncResult )
   {
      State^ tempState = dynamic_cast<State^>(asyncResult->AsyncState);
      int readCount = tempState->FStream->EndRead( asyncResult
 );
      int i = 0;
      while ( i < readCount )
      {
         if ( tempState->ReadArray[ i ] != tempState->WriteArray[
 i++ ] )
         {
            Console::WriteLine( "Error writing data." );
            tempState->FStream->Close();
            return;
         }
      }

      Console::WriteLine( "The data was written to {0} "
      "and verified.", tempState->FStream->Name );
      tempState->FStream->Close();
      
      // Signal the main thread that the verification is finished.
      tempState->ManualEvent->Set();
   }


public:

static void EndReadCallback(IAsyncResult asyncResult)
{
    State tempState = ((State)(asyncResult.get_AsyncState()));
    int readCount = tempState.get_FStream().EndRead(asyncResult);
    int i = 0;
    while((i < readCount)) {
        if ( tempState.get_ReadArray()[i] != 
                tempState.get_WriteArray()[i++] ) {
            Console.WriteLine("Error writing data.");
            tempState.get_FStream().Close();
            return;
        }
    }
    Console.WriteLine("The data was written to {0} and verified.",
        tempState.get_FStream().get_Name());
    tempState.get_FStream().Close();

    // Signal the main thread that the verification is finished.
    tempState.get_ManualEvent().Set();
} //EndReadCallback