BufferedStream.ReadAsync(Byte[], Int32, Int32, CancellationToken) Metod

Definition

Läser asynkront en sekvens med byte från den aktuella strömmen, avancerar positionen i strömmen med antalet lästa byte och övervakar begäranden om annullering.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parametrar

buffer
Byte[]

Bufferten som data ska skrivas till.

offset
Int32

Byteförskjutningen buffer där du börjar skriva data från dataströmmen.

count
Int32

Det maximala antalet byte som ska läsas.

cancellationToken
CancellationToken

Token som ska övervakas för annulleringsbegäranden.

Returer

En uppgift som representerar den asynkrona läsåtgärden. Den returnerade aktiviteten innehåller det totala antalet byte som lästs in i bufferten. Resultatvärdet kan vara mindre än det antal byte som begärs om antalet tillgängliga byte för närvarande är mindre än det begärda talet, eller om det kan vara 0 (noll) om strömmens slut har nåtts.

Undantag

buffer är null.

offset eller count är negativ.

Summan av offset och count är större än buffertlängden.

Strömmen stöder inte läsning.

Strömmen har tagits bort.

Strömmen används för närvarande av en tidigare läsåtgärd.

Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.

Kommentarer

Du kan skapa en annulleringstoken genom att skapa en instans av CancellationTokenSource klassen och skicka Token egenskapen som cancellationToken parameter.

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av Read(Byte[], Int32, Int32).

Gäller för