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

Definição

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Origem:

PipeStream.Unix.cs

Inicia uma operação de leitura assíncrona.

public:
 override IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);

public override IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback? callback, object? state);

override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult

Public Overrides 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 no qual os dados serão lidos.

offset

Int32

O deslocamento de bytes em buffer no qual será iniciada a leitura.

count

Int32

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

callback

AsyncCallback

O método a ser chamado quando a operação de leitura assíncrona é concluída.

state

Object

Um objeto fornecido pelo usuário que distingue essa solicitação de leitura assíncrona específica de outras solicitações.

Retornos

IAsyncResult

Um objeto IAsyncResult que referencia a leitura assíncrona.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset é menor que 0.

- ou -

count é menor que 0.

ArgumentException

count é maior que o número de bytes disponível no buffer.

ObjectDisposedException

O pipe está fechado.

NotSupportedException

O pipe não dá suporte a operações de leitura.

InvalidOperationException

O pipe está desconectado, esperando para conectar-se ou o identificador não foi definido.

IOException

O pipe está interrompido ou ocorreu outro erro de E/S.

Comentários

Passe o objeto retornado IAsyncResult para o EndRead método para determinar quantos bytes foram lidos e liberar os recursos do sistema operacional usados para leitura. EndRead deve ser chamado uma vez para cada chamada para BeginRead. Isso pode ser feito no mesmo código que chamou BeginRead ou em um retorno de chamada que é passado para BeginRead.

Use a CanRead propriedade para determinar se o objeto atual PipeStream dá suporte a operações de leitura.

Se o pipe for fechado ou um argumento inválido for passado para BeginRead, as exceções apropriadas serão geradas imediatamente. Erros que ocorrem durante uma solicitação de leitura assíncrona ocorrem no thread do pool de threads que está executando a solicitação. As exceções são geradas quando o código chama o EndRead método .