FileStream.Read FileStream.Read FileStream.Read FileStream.Read Method

定義

オーバーロード

Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32)

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

Read(Span<Byte>) Read(Span<Byte>) Read(Span<Byte>) Read(Span<Byte>)

現在のファイル ストリームからバイト シーケンスを読み取り、読み取られたバイト数だけファイル ストリーム内の位置を進めます。Reads a sequence of bytes from the current file stream and advances the position within the file stream by the number of bytes read.

Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32) Read(Byte[], Int32, Int32)

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

public:
 override int Read(cli::array <System::Byte> ^ array, int offset, int count);
public override int Read (byte[] array, int offset, int count);
override this.Read : byte[] * int * int -> int
Public Overrides Function Read (array As Byte(), offset As Integer, count As Integer) As Integer

パラメーター

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 Int32 Int32 Int32

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

count
Int32 Int32 Int32 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.

例外

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.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.

こちらもご覧ください

Read(Span<Byte>) Read(Span<Byte>) Read(Span<Byte>) Read(Span<Byte>)

現在のファイル ストリームからバイト シーケンスを読み取り、読み取られたバイト数だけファイル ストリーム内の位置を進めます。Reads a sequence of bytes from the current file stream and advances the position within the file stream by the number of bytes read.

public:
 override int Read(Span<System::Byte> buffer);
public override int Read (Span<byte> buffer);
override this.Read : Span<byte> -> int
Public Overrides Function Read (buffer As Span(Of Byte)) As Integer

パラメーター

buffer
Span<Byte>

メモリの領域。A region of memory. このメソッドが戻ると、この領域のコンテンツは現在のファイル ストリームから読み取られたバイトに置き換えられます。When this method returns, the contents of this region are replaced by the bytes read from the current file stream.

戻り値

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

注釈

現在のCanReadインスタンスが読み取りをサポートしているかどうかを確認するには、プロパティを使用します。Use the CanRead property to determine whether the current instance supports reading. 現在のReadAsyncストリームから非同期的に読み取るには、メソッドを使用します。Use the ReadAsync method to read asynchronously from the current stream.

このメソッドは、現在のbuffer.Lengthファイルストリームから最大バイトを読み取り、にbuffer格納します。This method reads a maximum of buffer.Length bytes from the current file stream and stores them in buffer. ファイルストリーム内の現在位置は、読み取ったバイト数だけ進んでいます。ただし、例外が発生した場合、ファイルストリーム内の現在位置は変更されません。The current position within the file stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the file stream remains unchanged. データが使用できない場合、メソッドは、少なくとも1バイトのデータを読み取ることができるようになるまでブロックします。The method will block until at least one byte of data can be read, in the event that no data is available. Readファイルストリームにデータがこれ以上ない場合にのみ0を返します。これ以上のデータは必要ありません (閉じているソケットやファイルの終端など)。Read returns 0 only when there is no more data in the file stream and no more is expected (such as a closed socket or end of file). メソッドは、ファイルストリームの末尾に到達していない場合でも、要求されたバイト数よりも小さい値を返すことができます。The method is free to return fewer bytes than requested even if the end of the file stream has not been reached.

プリミティブBinaryReaderデータ型の読み取りに使用します。Use BinaryReader for reading primitive data types.

適用対象