Class XzArchive

Class XzArchive

Namespace: Aspose.Zip.Xz
Assembly: Aspose.Zip.dll (25.1.0)

Ta klasa reprezentuje plik archiwum xz. Użyj jej do kompozycji i ekstrakcji archiwów xz.

public class XzArchive : IArchive, IDisposable, IArchiveFileEntry

Dziedziczenie

objectXzArchive

Implementuje

IArchive, IDisposable, IArchiveFileEntry

Członkowie dziedziczeni

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Konstruktorzy

XzArchive(XzArchiveSettings)

Inicjalizuje nową instancję klasy Aspose.Zip.Xz.XzArchive i tworzy archiwum w formacie xz.

public XzArchive(XzArchiveSettings settings = null)

Parametry

settings XzArchiveSettings

Zestaw ustawień dla konkretnego archiwum xz: rozmiar słownika, rozmiar bloku, typ sprawdzenia.

XzArchive(Stream)

Inicjalizuje nową instancję klasy Aspose.Zip.Xz.XzArchive przygotowaną do dekompresji.

public XzArchive(Stream source)

Parametry

source Stream

Źródło archiwum.

Uwagi

Ten konstruktor nie dekompresuje. Zobacz metodę Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) do dekompresji.

Wyjątki

ArgumentException

source nie jest możliwe do przeszukiwania.

ArgumentNullException

source jest null.

XzArchive(string)

Inicjalizuje nową instancję klasy Aspose.Zip.Xz.XzArchive przygotowaną do dekompresji.

public XzArchive(string path)

Parametry

path string

Ścieżka do źródła archiwum.

Uwagi

Ten konstruktor nie dekompresuje. Zobacz metodę Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) do dekompresji.

Wyjątki

ArgumentNullException

path jest null.

SecurityException

Wywołujący nie ma wymaganych uprawnień do dostępu.

ArgumentException

path jest pusty, zawiera tylko białe znaki lub zawiera nieprawidłowe znaki.

UnauthorizedAccessException

Dostęp do pliku path jest zabroniony.

PathTooLongException

Określona path, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą mieć mniej niż 248 znaków, a nazwy plików muszą mieć mniej niż 260 znaków.

NotSupportedException

Plik w path zawiera dwukropek (:) w środku ciągu.

FileNotFoundException

Plik nie został znaleziony.

DirectoryNotFoundException

Określona ścieżka jest nieprawidłowa, na przykład znajduje się na nieprzypisanym dysku.

IOException

Plik jest już otwarty.

Metody

Dispose()

Wykonuje zadania zdefiniowane przez aplikację związane z zwalnianiem, uwalnianiem lub resetowaniem niezarządzanych zasobów.

public void Dispose()

Dispose(bool)

Wykonuje zadania zdefiniowane przez aplikację związane z zwalnianiem, uwalnianiem lub resetowaniem niezarządzanych zasobów.

protected virtual void Dispose(bool disposing)

Parametry

disposing bool

Określa, czy zarządzane zasoby powinny zostać zwolnione.

Extract(Stream)

Ekstrahuje archiwum xz do strumienia.

public void Extract(Stream destination)

Parametry

destination Stream

Strumień do przechowywania zdekompresowanych danych.

Przykłady

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);
        }
    }
}

Wyjątki

InvalidOperationException

Nagłówki archiwum i informacje serwisowe nie zostały odczytane.

Extract(FileInfo)

Ekstrahuje archiwum xz do pliku.

public void Extract(FileInfo fileInfo)

Parametry

fileInfo FileInfo

FileInfo do przechowywania zdekompresowanych danych.

Przykłady

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

Wyjątki

InvalidOperationException

Nagłówki archiwum i informacje serwisowe nie zostały odczytane.

SecurityException

Wywołujący nie ma wymaganych uprawnień do otwarcia fileInfo.

ArgumentException

Ścieżka pliku jest pusta lub zawiera tylko białe znaki.

FileNotFoundException

Plik nie został znaleziony.

UnauthorizedAccessException

Ścieżka do pliku jest tylko do odczytu lub jest katalogiem.

ArgumentNullException

fileInfo jest null.

DirectoryNotFoundException

Określona ścieżka jest nieprawidłowa, na przykład znajduje się na nieprzypisanym dysku.

IOException

Plik jest już otwarty.

Extract(string)

Ekstrahuje archiwum xz do pliku według ścieżki.

public FileInfo Extract(string path)

Parametry

path string

Ścieżka do pliku, który będzie przechowywał zdekompresowane dane.

Zwraca

FileInfo

Instancja System.IO.FileInfo zawierająca wyodrębnione dane.

Przykłady

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

Wyjątki

InvalidOperationException

Nagłówki archiwum i informacje serwisowe nie zostały odczytane.

ArgumentNullException

path jest null.

SecurityException

Wywołujący nie ma wymaganych uprawnień do dostępu.

ArgumentException

path jest pusty, zawiera tylko białe znaki lub zawiera nieprawidłowe znaki.

UnauthorizedAccessException

Dostęp do pliku path jest zabroniony.

PathTooLongException

Określona path, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą mieć mniej niż 248 znaków, a nazwy plików muszą mieć mniej niż 260 znaków.

NotSupportedException

Plik w path zawiera dwukropek (:) w środku ciągu.

FileNotFoundException

Plik nie został znaleziony.

DirectoryNotFoundException

Określona ścieżka jest nieprawidłowa, na przykład znajduje się na nieprzypisanym dysku.

IOException

Plik jest już otwarty.

ExtractToDirectory(string)

Ekstrahuje zawartość archiwum do podanego katalogu.

public void ExtractToDirectory(string destinationDirectory)

Parametry

destinationDirectory string

Ścieżka do katalogu, w którym mają być umieszczone wyodrębnione pliki.

Uwagi

Jeśli katalog nie istnieje, zostanie utworzony.

Wyjątki

ArgumentNullException

destinationDirectory jest null.

PathTooLongException

Określona ścieżka, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą mieć mniej niż 248 znaków, a nazwy plików muszą mieć mniej niż 260 znaków.

SecurityException

Wywołujący nie ma wymaganych uprawnień do dostępu do istniejącego katalogu.

NotSupportedException

Jeśli katalog nie istnieje, ścieżka zawiera znak dwukropka (:) który nie jest częścią etykiety dysku (“C:").

ArgumentException

destinationDirectory jest ciągiem o zerowej długości, zawiera tylko białe znaki lub zawiera jeden lub więcej nieprawidłowych znaków. Możesz sprawdzić nieprawidłowe znaki, używając metody System.IO.Path.GetInvalidPathChars. -lub- ścieżka jest poprzedzona lub zawiera tylko znak dwukropka (:).

IOException

Katalog określony przez ścieżkę jest plikiem. -lub- Nazwa sieci nie jest znana.

Save(Stream)

Zapisuje archiwum xz do podanego strumienia.

public void Save(Stream output)

Parametry

output Stream

Strumień docelowy.

Przykłady

using (FileStream xzFile = File.Open("archive.xz", FileMode.Create))
{
    using (var archive = new XzArchive())
    {
        archive.SetSource("data.bin");
        archive.Save(xzFile);
     }
}

Uwagi

output musi być możliwy do przeszukiwania.

Wyjątki

ArgumentException

output nie obsługuje przeszukiwania.

ArgumentNullException

output jest null.

Save(string)

Zapisuje archiwum xz do podanego pliku docelowego.

public void Save(string destinationFileName)

Parametry

destinationFileName string

Ścieżka archiwum, które ma zostać utworzone. Jeśli określona nazwa pliku wskazuje na istniejący plik, zostanie on nadpisany.

Przykłady

using (var archive = new XzArchive()) 
{
    archive.SetSource(new FileInfo("data.bin"));
    archive.Save("result.xz");
}

Wyjątki

ArgumentNullException

destinationFileName jest null.

SecurityException

Wywołujący nie ma wymaganych uprawnień do dostępu.

ArgumentException

destinationFileName jest pusty, zawiera tylko białe znaki lub zawiera nieprawidłowe znaki.

UnauthorizedAccessException

Dostęp do pliku destinationFileName jest zabroniony.

PathTooLongException

Określona destinationFileName, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą mieć mniej niż 248 znaków, a nazwy plików muszą mieć mniej niż 260 znaków.

NotSupportedException

Plik w destinationFileName zawiera dwukropek (:) w środku ciągu.

SetSource(Stream)

Ustawia zawartość, która ma być skompresowana w archiwum.

public void SetSource(Stream source)

Parametry

source Stream

Strumień wejściowy dla archiwum.

Przykłady

using (var archive = new XzArchive())
{
    archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
    archive.Save("archive.xz");
}

Wyjątki

ArgumentException

Strumień source jest nieprzeszukiwany.

SetSource(FileInfo)

Ustawia zawartość, która ma być skompresowana w archiwum.

public void SetSource(FileInfo fileInfo)

Parametry

fileInfo FileInfo

FileInfo, który zostanie otwarty jako strumień wejściowy.

Przykłady

using (var archive = new XzArchive()) 
{
    archive.SetSource(new FileInfo("data.bin"));
    archive.Save("archive.xz");
}

Wyjątki

SecurityException

Wywołujący nie ma wymaganych uprawnień do otwarcia fileInfo.

ArgumentException

Ścieżka pliku jest pusta lub zawiera tylko białe znaki.

FileNotFoundException

Plik nie został znaleziony.

UnauthorizedAccessException

Ścieżka do pliku jest tylko do odczytu lub jest katalogiem.

ArgumentNullException

fileInfo jest null.

DirectoryNotFoundException

Określona ścieżka jest nieprawidłowa, na przykład znajduje się na nieprzypisanym dysku.

IOException

Plik jest już otwarty.

SetSource(string)

Ustawia zawartość, która ma być skompresowana w archiwum.

public void SetSource(string sourcePath)

Parametry

sourcePath string

Ścieżka do pliku, który zostanie otwarty jako strumień wejściowy.

Przykłady

using (var archive = new XzArchive()) 
{
    archive.SetSource("data.bin");
    archive.Save("archive.xz");
}

Wyjątki

ArgumentNullException

sourcePath jest null.

SecurityException

Wywołujący nie ma wymaganych uprawnień do dostępu.

ArgumentException

sourcePath jest pusty, zawiera tylko białe znaki lub zawiera nieprawidłowe znaki.

UnauthorizedAccessException

Dostęp do pliku sourcePath jest zabroniony.

PathTooLongException

Określona sourcePath, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą mieć mniej niż 248 znaków, a nazwy plików muszą mieć mniej niż 260 znaków.

NotSupportedException

Plik w sourcePath zawiera dwukropek (:) w środku ciągu.

 Polski