XzArchive.Extract

Extract(Stream)

Extracts xz archive to a stream.

public void Extract(Stream destination)
ParameterTypeDescription
destinationStreamStream for storing decompressed data.

Exceptions

exceptioncondition
ObjectDisposedExceptionArchive has been disposed and cannot be used.
InvalidOperationExceptionArchive headers and service information were not read.
OperationCanceledExceptionIn .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.

Examples

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (FileStream extractedFile = File.Open(extractedFileName, FileMode.Create))
    {
        using (var archive = new XzArchive(xzFile))
        {
            archive.Extract(extractedFile);
        }
    }
}

See Also

Extract(FileInfo)

Extracts xz archive to a file.

public void Extract(FileInfo fileInfo)
ParameterTypeDescription
fileInfoFileInfoFileInfo for storing decompressed data.

Exceptions

exceptioncondition
ObjectDisposedExceptionArchive has been disposed and cannot be used.
InvalidOperationExceptionArchive headers and service information were not read.
SecurityExceptionThe caller does not have the required permission to open the fileInfo.
ArgumentExceptionThe file path is empty or contains only white spaces.
FileNotFoundExceptionThe file is not found.
UnauthorizedAccessExceptionPath to file is read-only or is a directory.
ArgumentNullExceptionfileInfo is null.
DirectoryNotFoundExceptionThe specified path is invalid, such as being on an unmapped drive.
IOExceptionThe file is already open.
OperationCanceledExceptionIn .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.

Examples

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (var archive = new XzArchive(xzFile))
    {
        archive.Extract(new FileInfo("extracted.bin"));
    }
}

See Also

Extract(string)

Extracts xz archive to a file by path.

public FileInfo Extract(string path)
ParameterTypeDescription
pathStringPath to file which will store decompressed data.

Return Value

FileInfo instance containing extracted data.

Exceptions

exceptioncondition
ObjectDisposedExceptionArchive has been disposed and cannot be used.
InvalidOperationExceptionArchive headers and service information were not read.
ArgumentNullExceptionpath is null.
SecurityExceptionThe caller does not have the required permission to access.
ArgumentExceptionThe path is empty, contains only white spaces, or contains invalid characters.
UnauthorizedAccessExceptionAccess to file path is denied.
PathTooLongExceptionThe specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
NotSupportedExceptionFile at path contains a colon (:) in the middle of the string.
FileNotFoundExceptionThe file is not found.
DirectoryNotFoundExceptionThe specified path is invalid, such as being on an unmapped drive.
IOExceptionThe file is already open.
OperationCanceledExceptionIn .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.

Examples

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (var archive = new XzArchive(xzFile))
    {
        archive.Extract("extracted.bin");
    }
}

See Also

XzArchive.Dispose XzArchive.ExtractToDirectory