TarReader(Stream, Boolean) Constructor

Definition

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Source:

TarReader.cs

Initializes a TarReader instance that can read tar entries from the specified stream, and can optionally leave the stream open upon disposal of this instance.

public TarReader (System.IO.Stream archiveStream, bool leaveOpen = false);

new System.Formats.Tar.TarReader : System.IO.Stream * bool -> System.Formats.Tar.TarReader

Public Sub New (archiveStream As Stream, Optional leaveOpen As Boolean = false)

Parameters

archiveStream

Stream

The stream to read from.

leaveOpen

Boolean

false to dispose the archiveStream when this instance is disposed; true to leave the stream open.

Exceptions

ArgumentException

archiveStream does not support reading.

ArgumentNullException

archiveStream is null.