Class XarArchive
Nazwa przestrzeń: Aspose.Zip.Xar Zestawienie: Aspose.Zip.dll (25.5.0)
Ta klasa reprezentuje archiwum xar.
public class XarArchive : IArchive, IDisposable
Inheritance
Implements
Dziedziczeni członkowie
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Constructors
XarArchive(XarCompressionSettings)
Inicjalizuje nową instancję klasy Aspose.Zip.Xar.XarArchive.
public XarArchive(XarCompressionSettings defaultCompressionSettings = null)
Parameters
defaultCompressionSettings
XarCompressionSettings
Podstawowe ustawienia kompresji, stosowane do wszystkich wpisów w archiwum.
Examples
Poniższy przykład pokazuje, jak kompresować plik.
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}
XarArchive(Strumień, XarLoadOptions)
Inicjalizuje nową instancję klasy Aspose.Zip.xar.XarArchive i tworzy listę wpisów, które można wyciągnąć z archiwum.
public XarArchive(Stream sourceStream, XarLoadOptions loadOptions = null)
Parameters
sourceStream
Stream
Źródło archiwum - musi być wyszukiwane.
loadOptions
XarLoadOptions
Opcje do pobierania archiwum.
Examples
Poniższy przykład pokazuje, jak wyciągnąć wszystkie wpisy do katalogu.
using (var archive = new XarArchive(File.OpenRead("archive.xar")))
{
archive.ExtractToDirectory("C:\\extracted");
}
Remarks
Konstruktor ten nie odpakuje żadnych wpisów. zobacz Aspose.Zip.Xar.XarFileEntry.Open metoda do odpakowania.
Exceptions
sourceStream’ is null.
sourceStream’ is not seekable.
sourceStream’ is not valid xar archive.
XarArchive(Źródło: XarLoadOptions)
Inicjalizuje nową instancję klasy Aspose.Zip.xar.XarArchive i tworzy listę wpisów, które można wyciągnąć z archiwum.
public XarArchive(string path, XarLoadOptions loadOptions = null)
Parameters
path
string
Droga do archiwum.
loadOptions
XarLoadOptions
Opcje do pobierania archiwum.
Examples
Poniższy przykład pokazuje, jak wyciągnąć wszystkie wpisy do katalogu.
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}
Remarks
Konstruktor ten nie odpakuje żadnych wpisów. zobacz Aspose.Zip.Xar.XarFileEntry.Open metoda do odpakowania.
Exceptions
path’ is null.
Klient nie posiada wymaganego zezwolenia na dostęp.
Ścieżka " jest pusta, zawiera tylko białe przestrzenie lub zawiera nieprawidłowe znaky.
Dostęp do pliku path" jest odrzucony.
Określenie path", nazwa pliku lub obie przekracza maksymalną długość określoną przez system. Na przykład, na platformach opartych na systemie Windows, ścieżki muszą być mniejsze niż 248 znaków, a nazwy plików muszą być mniejsze niż 260 znaków.
Plik w path’ zawiera kolumnę (:) w środku paska.
Plik nie został znaleziony.
Określona ścieżka jest nieważna, na przykład na nieokreślonym dysku.
Archiwum jest już otwarte.
Archiwum w path’ nie jest ważnym archiwum xar.
Properties
Entries
Otrzymuje wpisy typu Aspose.Zip.Xar.XarEntry tworzącego archiwum.
public IEnumerable<xarentry> Entries { get; }
Wartość nieruchomości
IEnumerable • < XarEntry >
Methods
CreateEntries(Źródło: String, Bool, XarCompression)
Dodaj do archiwum wszystkie pliki i katalogi ponownie w danym katalogu.
public XarArchive CreateEntries(string sourceDirectory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)
Parameters
sourceDirectory
string
Dyrekcja do kompresji.
includeRootDirectory
bool
Oznacza, czy należy włączyć sam katalog korzeniowy, czy nie.
compressionSettings
XarCompressionSettings
Ustawienia kompresji używane do dodania elementów Aspose.Zip.Xar.XarEntry.
Returns
Wstęp do instancji.
Examples
using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
using (var archive = new XarArchive())
{
archive.CreateEntries(@"C:\folder", false);
archive.Save(xarFile);
}
}
Exceptions
sourceDirectory’ is null.
Wzywacz nie ma wymaganej zgody na dostęp do sourceDirectory'.
sourceDirectory’ contains invalid characters such as “, <, >, or |.
Na przykład, na platformach opartych na systemie Windows, ścieżki muszą być mniejsze niż 248 znaków, a nazwy plików muszą być mniejsze niż 260 znaków.
sourceDirectory’ stands for a file, not for a directory.
CreateEntries(DyrekcjaInfo, bool, XarCompressionSettings)
Dodaj do archiwum wszystkie pliki i katalogi ponownie w danym katalogu.
public XarArchive CreateEntries(DirectoryInfo directory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)
Parameters
directory
DirectoryInfo
Dyrekcja do kompresji.
includeRootDirectory
bool
Oznacza, czy należy włączyć sam katalog korzeniowy, czy nie.
compressionSettings
XarCompressionSettings
Ustawienia kompresji używane do dodania elementów Aspose.Zip.Xar.XarEntry.
Returns
Wstęp do instancji.
Examples
using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
using (var archive = new XarArchive())
{
archive.CreateEntries(new DirectoryInfo(@"C:\folder"), false);
archive.Save(xarFile);
}
}
Exceptions
directory’ is null.
Odwołujący nie ma wymaganej zgody na dostęp do adresatu directory”.
directory’ stands for a file, not for a directory.
CreateEntry(strona, FileInfo, bool, XarCompressionSettings)
Tworzenie jednego wpisu w archiwum.
public XarEntry CreateEntry(string name, FileInfo fileInfo, bool openImmediately = false, XarCompressionSettings compressionSettings = null)
Parameters
name
string
Nazwa wejścia.
fileInfo
FileInfo
Metadane plików lub folderów do kompresji.
openImmediately
bool
Prawda jest taka, że jeśli natychmiast otworzysz plik, w przeciwnym razie otwórz plik na archiwum.
compressionSettings
XarCompressionSettings
Ustawienia kompresji używane do dodania elementu Aspose.Zip.Xar.XarEntry.
Returns
Wstęp do instancji.
Examples
FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
archive.CreateEntry("test.bin", fileInfo);
archive.Save("archive.xar");
}
Remarks
Jeśli plik zostanie natychmiast otwarty parametrem, zostanie on zablokowany, dopóki nie zostanie usunięty archiwum.
Exceptions
name’ is null.
name’ is empty.
fileInfo’ is null.
CreateEntry(strona, strona, bool, XarCompressionSettings)
Tworzenie jednego wpisu w archiwum.
public XarEntry CreateEntry(string name, string sourcePath, bool openImmediately = false, XarCompressionSettings compressionSettings = null)
Parameters
name
string
Nazwa wejścia.
sourcePath
string
Ścieżka do rejestracji do kompresji.
openImmediately
bool
Prawda jest taka, że jeśli natychmiast otworzysz plik, w przeciwnym razie otwórz plik na archiwum.
compressionSettings
XarCompressionSettings
Ustawienia kompresji używane do dodania elementu Aspose.Zip.Xar.XarEntry.
Returns
Wstęp do instancji.
Examples
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}
Remarks
Nazwa wpisu jest ustawiona wyłącznie w parametrze. nazwa pliku podana w parametrze nie wpływa na nazwę wpisu.
Jeśli plik zostanie natychmiast otwarty parametrem, zostanie on zablokowany, dopóki nie zostanie usunięty archiwum.
Exceptions
sourcePath’ is null.
Klient nie posiada wymaganego zezwolenia na dostęp.
sourcePath’ jest pusta, zawiera tylko białe przestrzenie lub zawiera nieprawidłowe znaky. - lub - Nazwa pliku, jako część
name’, przekracza 100 symboli.
Dostęp do pliku sourcePath’ jest odrzucony.
Na przykład, na platformach opartych na systemie Windows, ścieżki muszą być mniejsze niż 248 znaków, a nazwy plików muszą być mniejsze niż 260 znaków. - lub - name’ jest zbyt długi dla xar.
Plik w sourcePath’ zawiera kolumnę (:) w środku paska.
Nie da się zmienić archiwum.
CreateEntry(strumień, strumień, XarCompressionSettings)
Tworzenie jednego wpisu w archiwum.
public XarEntry CreateEntry(string name, Stream source, XarCompressionSettings compressionSettings = null)
Parameters
name
string
Nazwa wejścia.
source
Stream
Przepływ wejściowy dla wejścia.
compressionSettings
XarCompressionSettings
Ustawienia kompresji używane do dodania elementu Aspose.Zip.Xar.XarEntry.
Returns
Wstęp do instancji.
Examples
using (var archive = new XarArchive())
{
archive.CreateEntry("data.bin", File.OpenRead("data.bin"));
archive.Save("archive.xar");
}
Exceptions
name’ is null.
source’ is null.
name’ is empty.
Nie da się zmienić archiwum.
DeleteEntry(XarEntry)
Usuwa pierwsze pojawienie się określonego wpisu z listy wpisów.
public XarArchive DeleteEntry(XarEntry entry)
Parameters
entry
XarEntry
Wstęp do usunięcia z listy wpisów.
Returns
Wstęp do instancji.
Examples
Oto jak można usunąć wszystkie wpisy z wyjątkiem ostatniego:
using (var archive = new XarArchive("archive.xar"))
{
while (archive.Entries.Count > 1)
archive.DeleteEntry(archive.Entries.FirstOrDefault());
archive.Save(outputXarFile);
}
Exceptions
entry’ is null.
Dispose()
Wykonywanie zadań określonych w aplikacji związanych z uwalnianiem, uwalnianiem lub ponownym uwalnianiem nie zarządzanych zasobów.
public void Dispose()
Dispose(Bool)
Wykonywanie zadań określonych w aplikacji związanych z uwalnianiem, uwalnianiem lub ponownym uwalnianiem nie zarządzanych zasobów.
protected virtual void Dispose(bool disposing)
Parameters
disposing
bool
Czy zarządzane zasoby powinny zostać usunięte?
ExtractToDirectory(strumień)
Wyciąga wszystkie pliki w archiwum do dostarczonego katalogu.
public void ExtractToDirectory(string destinationDirectory)
Parameters
destinationDirectory
string
Droga do katalogu, aby umieścić wyciągnięte pliki.
Examples
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}
Remarks
Jeśli dyrektywa nie istnieje, zostanie ona utworzona.
Exceptions
Droga jest zero
Na przykład, na platformach z systemem Windows, ścieżki muszą być mniejsze niż 248 znaków, a nazwy plików muszą być mniejsze niż 260 znaków.
Odwołujący nie posiada wymaganej pozwolenia na dostęp do istniejącego katalogu.
Jeśli dyrektywa nie istnieje, ścieżka zawiera znak kolumny (:) który nie jest częścią etykiety napędu (“C:”).
ścieżka jest ścieżką długości zerowej, zawiera tylko biały przestrzeń, lub zawiera jeden lub więcej nieprawidłowych znaków. można zapytać o nieprawidłowe znaky za pomocą metody System.IO.Path.GetInvalidPathChars. -or- ścieżka jest wyznaczona z, lub zawiera, tylko znak kolonu (:).
Dyskusja określona przez ścieżkę jest plikiem. -or- Nazwa sieci nie jest znana.
Archiwum jest zepsute.
Save(Źródło: XarSaveOptions)
Zapisz archiwum do dostarczonego pliku docelowego.
public void Save(string destinationFileName, XarSaveOptions saveOptions = null)
Parameters
destinationFileName
string
Jeśli określona nazwa pliku wskazuje na istniejący plik, zostanie on przesłany.
saveOptions
XarSaveOptions
Opcje do przechowywania archiwum xar z.
Exceptions
destinationFileName’ is null.
Nie da się zmienić archiwum.
Save(Strumień, XarSaveOptions)
Oszczędzaj archiwum na dostarczonym strumieniu.
public void Save(Stream output, XarSaveOptions saveOptions = null)
Parameters
output
Stream
Przepływ docelowy.
saveOptions
XarSaveOptions
Opcje do przechowywania archiwum xar z.
Exceptions
output’ is null.
output’Is not writable/readable or not seekable.
Nie da się zmienić archiwum.