FileStream.Read(Byte[], Int32, Int32) Method

定義

ストリームからバイトのブロックを読み取り、そのデータを特定のバッファーに書き込みます。 Reads a block of bytes from the stream and writes the data in a given buffer.

public override int Read (byte[] array, int offset, int count);
パラメーター
array
Byte[]

このメソッドが返されるときに、現在のソースから読み取られるバイトにより置き換えられた、offset と (offset + count - 1) の間の値を持つ指定されたバイト配列を含みます。 When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset
Int32

読み取られるバイトが配置される配列内のバイト オフセット。 The byte offset in array at which the read bytes will be placed.

count
Int32

読み取る最大バイト数。 The maximum number of bytes to read.

戻り値

バッファーに読み取られた合計バイト数。 The total number of bytes read into the buffer. 要求しただけのバイト数を読み取れなかった場合、この値は要求したバイト数より小さくなります。ストリームの末尾に到達した場合は 0 になることがあります。 This might be less than the number of bytes requested if that number of bytes are not currently available, or zero if the end of the stream is reached.

例外

arraynullです。 array is null.

offset または count が負の値です。 offset or count is negative.

ストリームは読み取りをサポートしません。 The stream does not support reading.

I/O エラーが発生しました。 An I/O error occurred.

offsetcountarray の無効な範囲を示しています。 offset and count describe an invalid range in array.

ストリームが閉じた後でメソッドが呼び出されました。 Methods were called after the stream was closed.

次の例から内容を読み取り、 FileStream 、別に書き込みますFileStreamします。The following example reads the contents from a FileStream and writes it into another FileStream.

using System;
using System.IO;

class Test
{

public static void Main()
{
    // Specify a file to read from and to create.
    string pathSource = @"c:\tests\source.txt";
    string pathNew = @"c:\tests\newfile.txt";

    try
    {

        using (FileStream fsSource = new FileStream(pathSource,
            FileMode.Open, FileAccess.Read))
        {

            // Read the source file into a byte array.
            byte[] bytes = new byte[fsSource.Length];
            int numBytesToRead = (int)fsSource.Length;
            int numBytesRead = 0;
            while (numBytesToRead > 0)
            {
                // Read may return anything from 0 to numBytesToRead.
                int n = fsSource.Read(bytes, numBytesRead, numBytesToRead);

                // Break when the end of the file is reached.
                if (n == 0)
                    break;

                numBytesRead += n;
                numBytesToRead -= n;
            }
             numBytesToRead = bytes.Length;

            // Write the byte array to the other FileStream.
            using (FileStream fsNew = new FileStream(pathNew,
                FileMode.Create, FileAccess.Write))
            {
                fsNew.Write(bytes, 0, numBytesToRead);
            }
        }
    }
    catch (FileNotFoundException ioEx)
    {
        Console.WriteLine(ioEx.Message);
    }
}
}
Imports System
Imports System.IO
Class Test
    
Public Shared Sub Main()
    ' Specify a file to read from and to create.
    Dim pathSource As String = "c:\tests\source.txt"
    Dim pathNew As String = "c:\tests\newfile.txt"
    Try 
        Using fsSource As FileStream = New FileStream(pathSource, _
            FileMode.Open, FileAccess.Read)
            ' Read the source file into a byte array.
                Dim bytes() As Byte = New Byte((fsSource.Length) - 1) {}
                Dim numBytesToRead As Integer = CType(fsSource.Length,Integer)
                Dim numBytesRead As Integer = 0

                While (numBytesToRead > 0)
                    ' Read may return anything from 0 to numBytesToRead.
                    Dim n As Integer = fsSource.Read(bytes, numBytesRead, _
                        numBytesToRead)
                    ' Break when the end of the file is reached.
                    If (n = 0) Then
                        Exit While
                    End If
                    numBytesRead = (numBytesRead + n)
                    numBytesToRead = (numBytesToRead - n)

                End While
            numBytesToRead = bytes.Length

            ' Write the byte array to the other FileStream.
            Using fsNew As FileStream = New FileStream(pathNew, _
                FileMode.Create, FileAccess.Write)
                fsNew.Write(bytes, 0, numBytesToRead)
            End Using
        End Using
    Catch ioEx As FileNotFoundException
        Console.WriteLine(ioEx.Message)
    End Try
End Sub
End Class

注釈

このメソッドは、Read をオーバーライドします。This method overrides Read.

offsetパラメーターは内のバイトのオフセットarray(バッファーのインデックス) 読み取りを開始する位置とcountパラメーターがこのストリームから読み取るバイトの最大数を示します。The offset parameter gives the offset of the byte in array (the buffer index) at which to begin reading, and the count parameter gives the maximum number of bytes to be read from this stream. 返される値は、ストリームの末尾に達した場合にバイトを読み取り、または 0 の実際の数です。The returned value is the actual number of bytes read, or zero if the end of the stream is reached. 読み取り操作が成功した場合は、読み取られたバイト数で、ストリームの現在位置が高度な。If the read operation is successful, the current position of the stream is advanced by the number of bytes read. 例外が発生する場合は、ストリームの現在の位置は変更されません。If an exception occurs, the current position of the stream is unchanged.

Readメソッドは、ストリームの末尾に到達した後にのみ 0 を返します。The Read method returns zero only after reaching the end of the stream. それ以外の場合、Read常に少なくとも 1 バイトを返す前に、ストリームから読み取ります。Otherwise, Read always reads at least one byte from the stream before returning. データがないかどうかを呼び出すとストリームからReadメソッドは、少なくとも 1 バイトのデータを返すことができるまでブロックされます。If no data is available from the stream upon a call to Read, the method will block until at least one byte of data can be returned. 実装は自由に、ストリームの末尾に達していない場合でも、要求されたより少ないバイト数を返します。An implementation is free to return fewer bytes than requested even if the end of the stream has not been reached.

使用BinaryReaderプリミティブ データ型を読み取るためです。Use BinaryReader for reading primitive data types.

読み取り操作を実行しているスレッドを中断しません。Do not interrupt a thread that is performing a read operation. スレッドがブロックされた後に正常に実行するアプリケーションが表示されますが、中断は、アプリケーションのパフォーマンスと信頼性を削減できます。Although the application may appear to run successfully after the thread is unblocked, the interruption can decrease your application's performance and reliability.

一般的なファイルとディレクトリの操作の一覧は、次を参照してください。共通 I/O タスクします。For a list of common file and directory operations, see Common I/O Tasks.

適用対象