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. Оно может быть меньше запрошенного числа байтов, если в настоящее время не имеется нужного количества байтов, или же равно нулю, если достигнут конец потока.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.

Исключения

Свойство array имеет значение null.array is null.

offset или count является отрицательным значением.offset or count is negative.

Поток не поддерживает чтение.The stream does not support reading.

Ошибка ввода/вывода.An I/O error occurred.

offset и count описывают недопустимый диапазон в array.offset and count describe an invalid range in array.

Методы были вызваны после закрытия потока.Methods were called after the stream was closed.

Примеры

В следующем примере считывается содержимое из FileStream и записывается в другое. FileStreamThe 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.

Параметр задает смещение байта в array (индекс буфера), с которого count начинается чтение, а параметр задает максимальное число байтов для чтения из этого потока. offsetThe 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. Возвращаемое значение — фактическое число считанных байтов или нуль, если достигнут конец потока.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 Метод возвращает нуль только после достижения конца потока.The Read method returns zero only after reaching the end of the stream. В противном случае всегда считывает по крайней мере один байт из потока перед возвратом. ReadOtherwise, Read always reads at least one byte from the stream before returning. Если данные из потока недоступны при вызове Readметода, метод блокируется до тех пор, пока не будет возвращен хотя бы один байт данных.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.

Список общих операций с файлами и каталогами см. в разделе Общие задачи ввода-вывода.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 байт из текущего файлового потока и сохраняет их в. bufferThis 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. Метод блокируется до тех пор, пока не будет прочитан хотя бы один байт данных в случае, если данные недоступны.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.

Применяется к