Stream.Read Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| Nome | Description |
|---|---|
| Read(Span<Byte>) |
Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos. |
| Read(Byte[], Int32, Int32) |
Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos. |
Read(Span<Byte>)
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
public:
virtual int Read(Span<System::Byte> buffer);
public virtual int Read(Span<byte> buffer);
abstract member Read : Span<byte> -> int
override this.Read : Span<byte> -> int
Public Overridable Function Read (buffer As Span(Of Byte)) As Integer
Parâmetros
Uma região de memória. Quando esse método retorna, o conteúdo dessa região é substituído pelos bytes lidos da fonte atual.
Retornos
O número total de bytes lidos no buffer. Isso pode 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 nenhum bytes tiver sido solicitado, algumas implementações poderão não ser concluídas 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 nenhum mais for esperado (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.
Aplica-se a
Read(Byte[], Int32, Int32)
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
- Origem:
- Stream.cs
Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
public:
abstract int Read(cli::array <System::Byte> ^ buffer, int offset, int count);
public abstract int Read(byte[] buffer, int offset, int count);
abstract member Read : byte[] * int * int -> int
Public MustOverride Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer
Parâmetros
- buffer
- Byte[]
Uma matriz de bytes. Quando esse método é retornado, 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 no buffer qual começar a armazenar os dados lidos do fluxo atual.
- count
- Int32
O número máximo de bytes a serem lidos do fluxo atual.
Retornos
O número total de bytes lidos no 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
A soma de offset e count é maior que o comprimento do buffer.
buffer é null.
offset ou count é negativo.
Ocorre um erro de E/S.
O fluxo não dá suporte à leitura.
Os métodos foram chamados depois que o fluxo foi fechado.
Exemplos
O exemplo a seguir mostra como usar Read para ler um bloco de dados.
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);
}
}
Imports System.IO
Public Class Block
Public Shared Sub Main()
Dim s As Stream = New MemoryStream()
For i As Integer = 0 To 121
s.WriteByte(CType(i, Byte))
Next i
s.Position = 0
' Now read s into a byte buffer that is padded slightly.
Dim bytes(s.Length + 10) As Byte
Dim numBytesToRead As Integer = s.Length
Dim numBytesRead As Integer = 0
Dim n As Integer
Do
' Read may return anything from 0 to 10.
n = s.Read(bytes, numBytesRead, 10)
' The end of the file is reached.
numBytesRead += n
numBytesToRead -= n
Loop While numBytesToRead > 0
s.Close()
Console.WriteLine("number of bytes read: {0:d}", numBytesRead)
End Sub
End Class
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 buffer início.offset 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 que nenhum bytes tenha 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 nenhum mais for esperado (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.