Stream.ReadAtLeastAsync Metod
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Läser asynkront minst ett minsta antal byte från den aktuella strömmen, avancerar positionen i strömmen med antalet lästa byte och övervakar begäranden om annullering.
public System.Threading.Tasks.ValueTask<int> ReadAtLeastAsync(Memory<byte> buffer, int minimumBytes, bool throwOnEndOfStream = true, System.Threading.CancellationToken cancellationToken = default);member this.ReadAtLeastAsync : Memory<byte> * int * bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Function ReadAtLeastAsync (buffer As Memory(Of Byte), minimumBytes As Integer, Optional throwOnEndOfStream As Boolean = true, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Parametrar
- minimumBytes
- Int32
Det minsta antalet byte som ska läsas in i bufferten.
- throwOnEndOfStream
- Boolean
true för att utlösa ett undantag om strömmens slut nås före läsning minimumBytes av byte. false För att returnera mindre än minimumBytes när strömmens slut nås.
Standardvärdet är true.
- cancellationToken
- CancellationToken
Token som ska övervakas för annulleringsbegäranden.
Returer
En uppgift som representerar den asynkrona läsåtgärden. Värdet för egenskapen Result innehåller det totala antalet byte som lästs in i bufferten. Detta är garanterat större än eller lika med minimumBytes när throwOnEndOfStream är true. Det här är mindre än minimumBytes när strömmens slut har nåtts och throwOnEndOfStream är false. Detta kan vara mindre än antalet byte som allokeras i bufferten om så många byte för närvarande inte är tillgängliga.
Undantag
minimumBytes är negativ eller är större än längden på buffer.
throwOnEndOfStream är true och slutet av strömmen nås innan byte av data läss minimumBytes .
Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.
Kommentarer
När minimumBytes är 0 (noll) slutförs den här läsåtgärden utan att vänta på tillgängliga data i dataströmmen.
