TarReader.GetNextEntryAsync(Boolean, CancellationToken) Methode

Definition

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Quelle:

TarReader.cs

Ruft den nächsten Eintrag asynchron aus dem Archivdatenstrom ab.

public System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry?> GetNextEntryAsync (bool copyData = false, System.Threading.CancellationToken cancellationToken = default);

member this.GetNextEntryAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry>

Public Function GetNextEntryAsync (Optional copyData As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TarEntry)

Parameter

copyData

Boolean

true , um die Daten des Eintrags in einen neuen MemoryStreamzu kopieren. Dies ist hilfreich, wenn der zugrunde liegende Archivstream die Suche nicht unterstützt und auf die Daten später zugegriffen werden muss.

false , wenn die Daten nicht in einen neuen Stream kopiert werden sollen. Wenn der zugrunde liegende Datenstrom die Suche nicht unterstützt, ist der Benutzer dafür verantwortlich, unmittelbar nach dem Aufrufen dieser Methode zu DataStream lesen und zu verarbeiten.

Standardwert: false.

cancellationToken

CancellationToken

Das Token zum Überwachen von Abbruchanforderungen. Der Standardwert ist None.

Gibt zurück

ValueTask<TarEntry>

Ein Werttask, der eine TarEntry instance enthält, wenn ein gültiger Eintrag gefunden wurde oder null das Ende des Archivs erreicht wurde.

Ausnahmen

InvalidDataException

Das Archiv ist falsch formatiert.

Oder

Das Archiv enthält Einträge in unterschiedlichen Formaten.

Oder

Im aktuellen Archiv wurde mehr als ein Eintrag zu globalen erweiterten Attributen Pax gefunden.

Oder

Im aktuellen Archiv wurden zwei oder mehr Einträge mit erweiterten Attributen Pax nacheinander gefunden.

IOException

Ein E/A-Problem ist aufgetreten.

OperationCanceledException

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Diese Methode speichert in der Aufgabe, die sie alle Nichtverwendungsausnahmen zurückgibt, die die synchrone Entsprechung der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Nutzungsausnahmen, z. B ArgumentException. , werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie unter die von ausgelösten GetNextEntry(Boolean)Ausnahmen.