TarArchive Members

IC Sharp Sharp Zip Lib

ICSharpCode SharpZipLib Class Library

TarArchive Members

TarArchive overview

Public Static Methods

CreateInputTarArchiveOverloaded. The InputStream based constructors create a TarArchive for the purposes of extracting or listing a tar archive. Thus, use these constructors when you wish to extract files from or list the contents of an existing tar archive.
CreateOutputTarArchiveOverloaded. Create a TarArchive for writing to, using the default blocking factor

Public Instance Properties

ApplyUserInfoOverrides Get or set a value indicating if overrides defined by SetUserInfo should be applied.
AsciiTranslate Get/set the ascii file translation flag. If ascii file translation is true, then the file is checked to see if it a binary file or not. If the flag is true and the test indicates it is ascii text file, it will be translated. The translation converts the local operating system's concept of line ends into the UNIX line end, '\n', which is the defacto standard for a TAR archive. This makes text files compatible with UNIX.
GroupId Get the archive group id. See ApplyUserInfoOverrides for detail on how to allow setting values on a per entry basis.
GroupName Get the archive group name. See ApplyUserInfoOverrides for detail on how to allow setting values on a per entry basis.
PathPrefix PathPrefix is added to entry names as they are written if the value is not null. A slash character is appended after PathPrefix
RecordSize Get the archive's record size. Tar archives are composed of a series of RECORDS each containing a number of BLOCKS. This allowed tar archives to match the IO characteristics of the physical device being used. Archives are expected to be properly "blocked".
RootPath RootPath is removed from entry names if it is found at the beginning of the name.
UserId Get the archive user id. See ApplyUserInfoOverrides for detail on how to allow setting values on a per entry basis.
UserName Get the archive user name. See ApplyUserInfoOverrides for detail on how to allow setting values on a per entry basis.

Public Instance Methods

Close Closes the archive and releases any associated resources.
CloseArchiveObsolete. Close the archive.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
ExtractContents Perform the "extract" command and extract the contents of the archive.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ListContents Perform the "list" command for the archive contents. NOTE That this method uses the progress event to actually list the contents. If the progress display event is not set, nothing will be listed!
SetAsciiTranslationObsolete. Set the ascii file translation flag.
SetKeepOldFiles Set the flag that determines whether existing files are kept, or overwritten during extraction.
SetUserInfo Set user and group information that will be used to fill in the tar archive's entry headers. This information based on that available for the linux operating system, which is not always available on other operating systems. TarArchive allows the programmer to specify values to be used in their place. ApplyUserInfoOverrides is set to true by this call.
ToString (inherited from Object) Returns a String that represents the current Object.
WriteEntry Write an entry to the archive. This method will call the putNextEntry and then write the contents of the entry, and finally call closeEntry() for entries that are files. For directories, it will call putNextEntry(), and then, if the recurse flag is true, process each entry that is a child of the directory.

Public Instance Events

ProgressMessageEvent Client hook allowing detailed information to be reported during processing

Protected Instance Constructors

TarArchive Overloaded. Initializes a new instance of the TarArchive class.

Protected Instance Methods

Dispose Releases the unmanaged resources used by the FileStream and optionally releases the managed resources.
Finalize Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the TarArchive.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnProgressMessageEvent Raises the ProgressMessage event

See Also

TarArchive Class | ICSharpCode.SharpZipLib.Tar Namespace