Stream.Read Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

Read(Span<Byte>)	Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.
Read(Byte[], Int32, Int32)	Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.

Read(Span<Byte>)

Origem:

Stream.cs

Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.

C#

public virtual int Read (Span<byte> buffer);

Parâmetros

buffer

Span<Byte>

Uma região da memória. Quando este método retorna, o conteúdo desta região é substituído pelos bytes lidos da fonte atual.

Retornos

Int32

O número total de bytes lidos do buffer. Isso poderá ser menor do que o tamanho do buffer se muitos bytes não estiverem disponíveis no momento ou zero (0) se o comprimento do buffer for zero ou o final do fluxo tiver sido atingido.

Comentários

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura. Use o ReadAsync método para ler de forma assíncrona do fluxo atual.

As implementações desse método leem um máximo de buffer.Length bytes do fluxo atual e os armazenam em buffer. A posição atual dentro do fluxo é avançada pelo número de bytes lidos; no entanto, se ocorrer uma exceção, a posição atual dentro do fluxo permanecerá inalterada. As implementações retornam o número de bytes lidos. Se mais de zero bytes forem solicitados, a implementação não concluirá a operação até que pelo menos um byte de dados possa ser lido (se zero bytes tiverem sido solicitados, algumas implementações poderão não ser concluídas da mesma forma até que pelo menos um byte esteja disponível, mas nenhum dado será consumido do fluxo nesse caso). Read retornará 0 somente se zero bytes tiverem sido solicitados ou quando não houver mais dados no fluxo e não for esperado mais (como um soquete fechado ou fim do arquivo). Uma implementação é livre para retornar menos bytes do que o solicitado, mesmo que o final do fluxo não tenha sido atingido.

Use BinaryReader para ler tipos de dados primitivos.

Read(Byte[], Int32, Int32)

Origem:

Stream.cs

Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.

C#

public abstract int Read (byte[] buffer, int offset, int count);

Parâmetros

buffer

Byte[]

Uma matriz de bytes. Quando esse método retorna, o buffer contém a matriz de bytes especificada com os valores entre offset e (offset + count -1) substituídos pelos bytes lidos da origem atual.

offset

Int32

O deslocamento de bytes baseado em zero em buffer no qual será iniciada a leitura de dados no fluxo atual.

count

Int32

O número máximo de bytes a serem lidos no fluxo atual.

Retornos

Int32

O número total de bytes lidos do buffer. Isso pode ser menor do que o número de bytes solicitados se muitos bytes não estiverem disponíveis no momento ou zero (0) se count for 0 ou o final do fluxo tiver sido atingido.

Exceções

ArgumentException

A soma de offset e count é maior que o tamanho do buffer.

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

IOException

Ocorre um erro de E/S.

NotSupportedException

Não há suporte para leitura no fluxo.

ObjectDisposedException

Foram chamados métodos depois que o fluxo foi fechado.

Exemplos

O exemplo a seguir mostra como usar Read para ler um bloco de dados.

C#

using System;
using System.IO;

public class Block
{
    public static void Main()
    {
        Stream s = new MemoryStream();
        for (int i = 0; i < 122; i++)
        {
            s.WriteByte((byte)i);
        }
        s.Position = 0;

        // Now read s into a byte buffer with a little padding.
        byte[] bytes = new byte[s.Length + 10];
        int numBytesToRead = (int)s.Length;
        int numBytesRead = 0;
        do
        {
            // Read may return anything from 0 to 10.
            int n = s.Read(bytes, numBytesRead, 10);
            numBytesRead += n;
            numBytesToRead -= n;
        } while (numBytesToRead > 0);
        s.Close();

        Console.WriteLine("number of bytes read: {0:d}", numBytesRead);
    }
}

Comentários

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura. Use o ReadAsync método para ler de forma assíncrona do fluxo atual.

As implementações desse método leem um máximo de count bytes do fluxo atual e os armazenam no início em bufferoffset. A posição atual dentro do fluxo é avançada pelo número de bytes lidos; no entanto, se ocorrer uma exceção, a posição atual dentro do fluxo permanecerá inalterada. As implementações retornam o número de bytes lidos. Se mais de zero bytes forem solicitados, a implementação não concluirá a operação até que pelo menos um byte de dados possa ser lido (algumas implementações podem não ser concluídas da mesma forma até que pelo menos um byte esteja disponível mesmo se nenhum bytes tiver sido solicitado, mas nenhum dado será consumido do fluxo nesse caso). Read retornará 0 somente se zero bytes tiverem sido solicitados ou quando não houver mais dados no fluxo e não for esperado mais (como um soquete fechado ou fim do arquivo). Uma implementação é livre para retornar menos bytes do que o solicitado, mesmo que o final do fluxo não tenha sido atingido.

Use BinaryReader para ler tipos de dados primitivos.

Confira também

• E/S de arquivo e de fluxo
• Como ler texto de um arquivo
• Como gravar texto em um arquivo