Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) Método

Definição

Inicia uma operação de leitura assíncrona.Begins an asynchronous read operation. (Considere o uso de ReadAsync(Byte[], Int32, Int32) em seu lugar.)(Consider using ReadAsync(Byte[], Int32, Int32) instead.)

public:
 virtual IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);
public virtual IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object state);
abstract member BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult
Public Overridable Function BeginRead (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult

Parâmetros

buffer
Byte[]

O buffer para ler os dados.The buffer to read the data into.

offset
Int32

O deslocamento de bytes no buffer no qual será iniciada a gravação da leitura de dados no fluxo.The byte offset in buffer at which to begin writing data read from the stream.

count
Int32

O número máximo de bytes a serem lidos.The maximum number of bytes to read.

callback
AsyncCallback

Um retorno de chamada assíncrono opcional, a ser chamado quando a leitura for concluída.An optional asynchronous callback, to be called when the read is complete.

state
Object

Um objeto fornecido pelo usuário que distingue essa solicitação de leitura assíncrona específica de outras solicitações.A user-provided object that distinguishes this particular asynchronous read request from other requests.

Retornos

Um IAsyncResult que representa a operação de leitura assíncrona, que ainda pode estar pendente.An IAsyncResult that represents the asynchronous read, which could still be pending.

Exceções

Tentativa de uma leitura assíncrona após o final do fluxo ou ocorre um erro de disco.Attempted an asynchronous read past the end of the stream, or a disk error occurs.

Um ou mais argumentos são inválidos.One or more of the arguments is invalid.

Foram chamados métodos depois que o fluxo foi fechado.Methods were called after the stream was closed.

A implementação Stream atual não dá suporte à operação de leitura.The current Stream implementation does not support the read operation.

Comentários

No .NET Framework 4, e em versões anteriores, você precisa usar métodos como BeginRead e EndRead para implementar operações de E/S assíncronas.In the .NET Framework 4 and earlier versions, you have to use methods such as BeginRead and EndRead to implement asynchronous I/O operations. Esses métodos .NET Framework 4.5.NET Framework 4.5 ainda estão disponíveis no para dar suporte ao código herdado; no entanto, os novos métodos assíncronos, ReadAsync WriteAsync CopyToAsynccomo FlushAsync,, e, ajudam você a implementar operações de e/s assíncronas com mais facilidade.These methods are still available in the .NET Framework 4.5.NET Framework 4.5 to support legacy code; however, the new async methods, such as ReadAsync, WriteAsync, CopyToAsync, and FlushAsync, help you implement asynchronous I/O operations more easily.

A implementação padrão de BeginRead em um fluxo chama o Read método de forma síncrona, o Read que significa que pode bloquear em alguns fluxos.The default implementation of BeginRead on a stream calls the Read method synchronously, which means that Read might block on some streams. No entanto, as instâncias de FileStream classes NetworkStream , como e oferecem suporte total a operações assíncronas, se as instâncias tiverem sido abertas de forma assíncrona.However, instances of classes such as FileStream and NetworkStream fully support asynchronous operations if the instances have been opened asynchronously. Portanto, as chamadas BeginRead para não serão bloqueadas nesses fluxos.Therefore, calls to BeginRead will not block on those streams. Você pode substituir BeginRead (usando delegados assíncronos, por exemplo) para fornecer comportamento assíncrono.You can override BeginRead (by using async delegates, for example) to provide asynchronous behavior.

Passe o IAsyncResult valor de retorno para EndRead o método do fluxo para determinar quantos bytes foram lidos e para liberar os recursos do sistema operacional usados para leitura.Pass the IAsyncResult return value to the EndRead method of the stream to determine how many bytes were read and to release operating system resources used for reading. EndReaddeve ser chamado uma vez para cada chamada BeginReadpara.EndRead must be called once for every call to BeginRead. Isso pode ser feito usando o mesmo código chamado BeginRead ou em um retorno de chamada passado para. BeginReadYou can do this either by using the same code that called BeginRead or in a callback passed to BeginRead.

A posição atual no fluxo é atualizada quando a leitura ou gravação assíncrona é emitida, não quando a operação de e/s é concluída.The current position in the stream is updated when the asynchronous read or write is issued, not when the I/O operation completes.

Várias solicitações assíncronas simultâneas tornam a ordem de conclusão da solicitação incerta.Multiple simultaneous asynchronous requests render the request completion order uncertain.

Use a CanRead propriedade para determinar se a instância atual oferece suporte à leitura.Use the CanRead property to determine whether the current instance supports reading.

Se um fluxo for fechado ou você passar um argumento inválido, as exceções serão geradas BeginReadimediatamente do.If a stream is closed or you pass an invalid argument, exceptions are thrown immediately from BeginRead. Os erros que ocorrem durante uma solicitação de leitura assíncrona, como uma falha de disco durante a solicitação de e/s, ocorrem no thread do pool de threads e geram exceções ao chamar EndRead.Errors that occur during an asynchronous read request, such as a disk failure during the I/O request, occur on the thread pool thread and throw exceptions when calling EndRead.

Aplica-se a

Veja também