Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) Method

Definition

Startet einen asynchronen Lesevorgang.Begins an asynchronous read operation. (Verwenden Sie stattdessen ReadAsync(Byte[], Int32, Int32).)(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

Parameters

buffer
Byte[]

Der Puffer, in den die Daten eingelesen werden.The buffer to read the data into.

offset
Int32

Der Byteoffset im buffer, ab dem aus dem Stream gelesene Daten geschrieben werden.The byte offset in buffer at which to begin writing data read from the stream.

count
Int32

Die maximale Anzahl der zu lesenden Bytes.The maximum number of bytes to read.

callback
AsyncCallback

Ein optionaler asynchroner Rückruf, der ausgeführt wird, wenn der Lesevorgang abgeschlossen wurde.An optional asynchronous callback, to be called when the read is complete.

state
Object

Ein vom Benutzer bereitgestelltes Objekt, das zwischen dieser bestimmten asynchronen Leseanforderung und anderen Anforderungen unterscheidet.A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

IAsyncResult

Ein IAsyncResult, das den asynchronen Lesevorgang darstellt, der möglicherweise noch aussteht.An IAsyncResult that represents the asynchronous read, which could still be pending.

Exceptions

Es wurde versucht, einen asynchronen Lesevorgang über das Ende des Streams hinaus durchzuführen, oder es ist ein Datenträgerfehler aufgetreten.Attempted an asynchronous read past the end of the stream, or a disk error occurs.

Mindestens eines der Argumente ist ungültig.One or more of the arguments is invalid.

Es wurden Methoden aufgerufen, nachdem der Stream geschlossen wurde.Methods were called after the stream was closed.

Die aktuelle Stream-Implementierung unterstützt den Lesevorgang nicht.The current Stream implementation does not support the read operation.

Remarks

In .NET Framework 4 und vorherigen Versionen müssen Sie Methoden wie BeginRead und EndRead verwenden, um asynchrone E/A-Vorgänge zu implementieren.In the .NET Framework 4 and earlier versions, you have to use methods such as BeginRead and EndRead to implement asynchronous I/O operations. Diese Methoden sind weiterhin im .NET Framework 4.5.NET Framework 4.5 verfügbar, um Legacy Code zu unterstützen. die neuen Async-Methoden, wie z. b. ReadAsync, WriteAsync, CopyToAsyncund FlushAsync, unterstützen Sie jedoch bei der einfacheren Implementierung asynchroner e/a-Vorgänge.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.

Die Standard Implementierung von BeginRead in einem Stream ruft die Methode Read synchron auf, was bedeutet, dass Read in einigen Streams blockieren könnte.The default implementation of BeginRead on a stream calls the Read method synchronously, which means that Read might block on some streams. Instanzen von Klassen, z. b. FileStream und NetworkStream, unterstützen asynchrone Vorgänge jedoch vollständig, wenn die Instanzen asynchron geöffnet wurden.However, instances of classes such as FileStream and NetworkStream fully support asynchronous operations if the instances have been opened asynchronously. Daher werden Aufrufe von BeginRead für diese Streams nicht blockiert.Therefore, calls to BeginRead will not block on those streams. Sie können BeginRead überschreiben (z. b. mithilfe von Async-Delegaten), um asynchrones Verhalten bereitzustellen.You can override BeginRead (by using async delegates, for example) to provide asynchronous behavior.

Übergeben Sie den IAsyncResult Rückgabewert an die EndRead-Methode des Streams, um zu bestimmen, wie viele Bytes gelesen wurden, und um die zum Lesen verwendeten Betriebssystemressourcen freizugeben.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. EndRead müssen für jeden Aufruf von BeginReadeinmal aufgerufen werden.EndRead must be called once for every call to BeginRead. Hierzu können Sie den gleichen Code verwenden, der auch BeginRead aufgerufen hat, oder in einem Rückruf, der an BeginReadübermittelt wurde.You can do this either by using the same code that called BeginRead or in a callback passed to BeginRead.

Die aktuelle Position im Stream wird aktualisiert, wenn der asynchrone Lese-oder Schreibvorgang ausgegeben wird, und nicht, wenn der e/a-Vorgang abgeschlossen wird.The current position in the stream is updated when the asynchronous read or write is issued, not when the I/O operation completes.

Durch mehrere gleichzeitige asynchrone Anforderungen wird die Reihenfolge der Anforderungs Vervollständigung unsicher.Multiple simultaneous asynchronous requests render the request completion order uncertain.

Verwenden Sie die CanRead-Eigenschaft, um zu bestimmen, ob die aktuelle Instanz Lesevorgänge unterstütztUse the CanRead property to determine whether the current instance supports reading.

Wenn ein Stream geschlossen wird oder Sie ein ungültiges Argument übergeben, werden Ausnahmen sofort aus BeginReadausgelöst.If a stream is closed or you pass an invalid argument, exceptions are thrown immediately from BeginRead. Fehler, die während einer asynchronen Lese Anforderung auftreten, z. b. ein Datenträger Fehler während der e/a-Anforderung, treten im Thread Pool Thread auf und lösen Ausnahmen aus, wenn EndReadaufgerufen wird.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.

Applies to

See also