PipeStream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) Metoda

Definicja

Rozpoczęcie asynchronicznej operacji odczytu.Begins an asynchronous read operation.

public:
 override IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);
[System.Security.SecurityCritical]
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

Parametry

buffer
Byte[]

Bufor, do którego mają zostać odczytane dane.The buffer to read data into.

offset
Int32

Przesunięcie bajtów w buffer, w którym ma zostać rozpoczęte odczytywanie.The byte offset in buffer at which to begin reading.

count
Int32

Maksymalna liczba bajtów do odczytania.The maximum number of bytes to read.

callback
AsyncCallback

Metoda wywoływana po zakończeniu asynchronicznej operacji odczytu.The method to call when the asynchronous read operation is completed.

state
Object

Obiekt udostępniony przez użytkownika, który odróżnia to konkretne asynchroniczne żądanie odczytu z innych żądań.A user-provided object that distinguishes this particular asynchronous read request from other requests.

Zwraca

Obiekt IAsyncResult, który odwołuje się do odczytu asynchronicznego.An IAsyncResult object that references the asynchronous read.

Atrybuty

Wyjątki

Parametr buffer ma wartość null.buffer is null.

Parametr offset ma wartość mniejszą niż 0.offset is less than 0.

lub-or- Parametr count ma wartość mniejszą niż 0.count is less than 0.

count jest większa niż liczba bajtów dostępnych w buffer.count is greater than the number of bytes available in buffer.

Potok jest zamknięty.The pipe is closed.

Potok nie obsługuje operacji odczytu.The pipe does not support read operations.

Potok jest odłączony, oczekiwanie na połączenie lub dojście nie zostało ustawione.The pipe is disconnected, waiting to connect, or the handle has not been set.

Potok jest przerwany lub Wystąpił inny błąd we/wy.The pipe is broken or another I/O error occurred.

Uwagi

Przekaż zwrócony obiekt IAsyncResult do metody EndRead, aby określić, ile bajtów zostało odczytanych i aby zwolnić zasoby systemu operacyjnego używane do odczytu.Pass the returned IAsyncResult object to the EndRead method to determine how many bytes were read and to release operating system resources used for reading. EndRead musi być wywoływana jednokrotnie dla każdego wywołania do BeginRead.EndRead must be called once for every call to BeginRead. Można to zrobić w tym samym kodzie, który o nazwie BeginRead lub wywołania zwrotnego, które jest przesyłane do BeginRead.This can be done either in the same code that called BeginRead or in a callback that is passed to BeginRead.

Użyj właściwości CanRead, aby określić, czy bieżący obiekt PipeStream obsługuje operacje odczytu.Use the CanRead property to determine whether the current PipeStream object supports read operations.

Jeśli potok jest zamknięty lub przeszedł nieprawidłowy argument do BeginRead, odpowiednie wyjątki są wywoływane natychmiast.If the pipe is closed or an invalid argument is passed to BeginRead, the appropriate exceptions are raised immediately. Błędy występujące podczas asynchronicznego żądania odczytu są wykonywane w wątku puli wątków, który wykonuje żądanie.Errors that occur during an asynchronous read request occur on the thread pool thread that is performing the request. Wyjątki są wywoływane, gdy kod wywołuje metodę EndRead.The exceptions are raised when the code calls the EndRead method.

Dotyczy