TarReader.GetNextEntry(Boolean) Method

Definition

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Source:

TarReader.cs

Retrieves the next entry from the archive stream.

public System.Formats.Tar.TarEntry? GetNextEntry (bool copyData = false);

member this.GetNextEntry : bool -> System.Formats.Tar.TarEntry

Public Function GetNextEntry (Optional copyData As Boolean = false) As TarEntry

Parameters

copyData

Boolean

true to copy the data of the entry into a new MemoryStream. This is helpful when the underlying archive stream is unseekable, and the data needs to be accessed later.

false if the data should not be copied into a new stream. If the underlying stream is unseekable, the user has the responsibility of reading and processing the DataStream immediately after calling this method.

The default value is false.

Returns

TarEntry

A TarEntry instance if a valid entry was found, or null if the end of the archive has been reached.

Exceptions

InvalidDataException

The entry's data is malformed.

-or-

The archive contains entries in different formats.

-or-

More than one global extended attributes entry was found in the current Pax archive.

-or-

Two or more extended attributes entries were found consecutively in the current Pax archive.

IOException

An I/O problem occurred.