Class IronBZip2Archive

An IronBZip2Archive for bzip2-type ".bz2" Archives

Inheritance
System.Object
IronBaseArchive
IronBZip2Archive
Implements
System.IDisposable
Inherited Members
Namespace: IronZip
Assembly: IronZip.dll
Syntax
public class IronBZip2Archive : IronBaseArchive, IDisposable

Constructors

IronBZip2Archive()

Creates a blank Archive. Please use in a using block. Use the SaveAs method to export the archive.

Declaration
public IronBZip2Archive()

IronBZip2Archive(String)

Open an existing Archive with a filename. Please use in a using block. Use the SaveAs method to export the archive.

Declaration
public IronBZip2Archive(string ArchivePath)
Parameters
Type Name Description
System.String ArchivePath

File path to open the existing Archive. Example: 

/output/a.bz2
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()

Check the license before using IronZIP

Declaration
public override void Dispose()
Overrides
Exceptions
Type Condition
IronSoftware.Exceptions.LicensingException

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 IronBZip2Archive FromFile(string FilePath)
Parameters
Type Name Description
System.String FilePath

File Entry to add to the Archive
Returns
Type Description
IronBZip2Archive

Returns the constructed IronBZip2Archive 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 IronBZip2Archive FromFiles(string[] Paths)
Parameters
Type Name Description
System.String[] Paths

File Entries to add to the Archive
Returns
Type Description
IronBZip2Archive

Returns the constructed IronBZip2Archive with the file entries added.

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

Implements

System.IDisposable

Inherited members

_storedArchivePath
_internalStream
isDisposed