Class IronTarArchive
An IronTarArchive for tar-type ".tar" Archives
Implements
Inherited Members
Namespace: IronZip
Assembly: IronZip.dll
Syntax
public class IronTarArchive : IronBaseArchive, IDisposable
Constructors
IronTarArchive()
Creates a blank Archive. Please use in a using
block. Use the SaveAs method to export the archive.
Declaration
public IronTarArchive()
IronTarArchive(String)
Open an existing Archive. Please use in a using
block. Use the SaveAs method to export the archive.
Declaration
public IronTarArchive(string ArchivePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | ArchivePath | File path to open the existing Archive. Example: You may use an absolute path.
|
Methods
Add(String)
Adds an archive entry (file) to the Archive. These entries will appear as files when the Archive is extracted.
Declaration
public void Add(string EntryFilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | EntryFilePath | Filepath to the archive entry to add |
AddArchiveEntry(String)
Adds an archive entry (file) to the Archive. These entries will appear as files when the Archive is extracted.
Declaration
public void AddArchiveEntry(string EntryFilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | EntryFilePath | Filepath to the archive entry to add |
Dispose()
Declaration
public override void Dispose()
Overrides
ExtractArchiveToDirectory(String, String)
Will load an Archive and extract it to a Directory (System Folder)
Declaration
public static void ExtractArchiveToDirectory(string ArchiveSourcePath, string SaveDirectoryPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | ArchiveSourcePath | Path to the Archive to extract |
System.String | SaveDirectoryPath | Directory to extract files to |
FromFile(String)
Creates an Archive with a specific file to add to it. Please use in a using
block. Use the SaveAs method to export the archive.
Declaration
public static IronTarArchive FromFile(string FilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | FilePath | File Entry to add to the Archive |
Returns
Type | Description |
---|---|
IronTarArchive | Returns the constructed IronTarArchive with the file entry added. |
FromFiles(String[])
Creates an Archive with some files to add to it. Please use in a using
block. Use the SaveAs method to export the archive.
Declaration
public static IronTarArchive FromFiles(string[] Paths)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | Paths | File Entries to add to the Archive |
Returns
Type | Description |
---|---|
IronTarArchive | Returns the constructed IronTarArchive with the file entries added. |
GetArchiveEntryNames()
Load the entry / entries of an existing Archive
Declaration
public List<string> GetArchiveEntryNames()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Save()
Save the archive
Declaration
public override void Save()
Overrides
Remarks
Users cannot add additional entries after saving
SaveAs(String)
Save the archive to the specified path
Declaration
public override void SaveAs(string Path)
Parameters
Type | Name | Description |
---|---|---|
System.String | Path | Save path |
Overrides
Remarks
Users cannot add additional entries after saving