Class XarArchive
Der Name: Aspose.Zip.Xar Versammlung: Aspose.Zip.dll (25.5.0)
Diese Klasse repräsentiert eine ARCHIV-Datei.
public class XarArchive : IArchive, IDisposableInheritance
Implements
Vererbte Mitglieder
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Constructors
XarArchive(XarCompressionSettings)
Initialisiert eine neue Instanz der Aspose.Zip.Xar.XarArchive Klasse.
public XarArchive(XarCompressionSettings defaultCompressionSettings = null)Parameters
defaultCompressionSettings XarCompressionSettings
Die standardmäßigen Kompressionseinstellungen, die auf alle Einträge des Archivs angewendet werden.
Examples
Das folgende Beispiel zeigt, wie man eine Datei komprimiert.
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}XarArchive(Stream, XarLoadOptions)
Initialisiert eine neue Instanz der Aspose.Zip.Xar.xarArchive-Klasse und stellt eine Eintrittsliste aus dem Archiv heraus.
public XarArchive(Stream sourceStream, XarLoadOptions loadOptions = null)Parameters
sourceStream Stream
Die Quelle des Archivs. es muss nachfindlich sein.
loadOptions XarLoadOptions
Die Optionen zum Laden von Archiv mit.
Examples
Das folgende Beispiel zeigt, wie man alle Beiträge in ein Katalog extrahiert.
using (var archive = new XarArchive(File.OpenRead("archive.xar")))
{
archive.ExtractToDirectory("C:\\extracted");
}Remarks
Dieser Konstruktor entpackt keine Einträge. siehe Aspose.Zip.Xar.XarFileEntry.Open Methode für Entpacken.
Exceptions
sourceStream’ is null.
sourceStream’ is not seekable.
sourceStream’ is not valid xar archive.
XarArchive(String, XarLoadOptions)
Initialisiert eine neue Instanz der Aspose.Zip.Xar.xarArchive-Klasse und stellt eine Eintrittsliste aus dem Archiv heraus.
public XarArchive(string path, XarLoadOptions loadOptions = null)Parameters
path string
Der Weg zum Archiv.
loadOptions XarLoadOptions
Die Optionen zum Laden von Archiv mit.
Examples
Das folgende Beispiel zeigt, wie man alle Beiträge in ein Katalog extrahiert.
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}Remarks
Dieser Konstruktor entpackt keine Einträge. siehe Aspose.Zip.Xar.XarFileEntry.Open Methode für Entpacken.
Exceptions
path’ is null.
Der Anrufgeber hat nicht die erforderliche Erlaubnis für den Zugang.
Die path’ ist leer, enthält nur weiße Räume oder enthält ungültige Zeichen.
Der Zugriff auf die Datei path" wird abgelehnt.
Die angegebenen path’, Dateinamen, oder beide überschreiten die Systemdefinierte maximale Länge. Zum Beispiel auf Windows-basierten Plattformen müssen die Paths weniger als 248 Zeichen und Dateinamen weniger als 260 Zeichen sein.
Die Datei bei path’ enthält eine Kolonne (:) in der Mitte der Zeile.
Die Datei ist nicht gefunden.
Der angegebenen Weg ist ungültig, z. B. auf einem unmapped Drive.
Die Datei ist bereits geöffnet.
Datei bei path’ ist nicht gültig xar archive.
Properties
Entries
Er bekommt Beiträge von Aspose.Zip.Xar.XarEntry Typ, die das Archiv darstellt.
public IEnumerable<xarentry> Entries { get; }Eigentumswert
IEnumerable &undlt; XarEntry >
Methods
CreateEntries(String, Bool, XarCompressionSettings)
Add to the archive all the files and directories recurrently in the given directory. - Add to the archive all the files and directories recurrently in the given directory.
public XarArchive CreateEntries(string sourceDirectory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)Parameters
sourceDirectory string
Verzeichnis zum Komprimieren.
includeRootDirectory bool
Angibt, ob die Root-Dokumentation selbst enthalten ist oder nicht.
compressionSettings XarCompressionSettings
Die Kompressionseinstellungen verwendet, um Aspose.Zip.Xar.XarEntry Elemente hinzuzufügen.
Returns
Eintrittsinstanz von Xar.
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.
Der Anrufgeber hat nicht die erforderliche Erlaubnis zum Zugriff auf sourceDirectory'.
sourceDirectory’ contains invalid characters such as “, <, >, or |.
Die angegebenen Path, Dateinamen oder beide überschreiten die Systemdefinierte maximale Länge. Zum Beispiel müssen auf Windows-basierten Plattformen Paths weniger als 248 Zeichen und Dateinamen weniger als 260 Zeichen sein.
sourceDirectory’ stands for a file, not for a directory.
CreateEntries(DirectoryInfo, Bool, XarCompressionSettings)
Add to the archive all the files and directories recurrently in the given directory. - Add to the archive all the files and directories recurrently in the given directory.
public XarArchive CreateEntries(DirectoryInfo directory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)Parameters
directory DirectoryInfo
Verzeichnis zum Komprimieren.
includeRootDirectory bool
Angibt, ob die Root-Dokumentation selbst enthalten ist oder nicht.
compressionSettings XarCompressionSettings
Die Kompressionseinstellungen verwendet, um Aspose.Zip.Xar.XarEntry Elemente hinzuzufügen.
Returns
Eintrittsinstanz von Xar.
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.
Der Anrufgeber hat nicht die erforderliche Erlaubnis zum Zugriff auf directory'.
directory’ stands for a file, not for a directory.
CreateEntry(String, FileInfo, Bool, XarCompressionSettings)
Erstellen Sie einen einzigen Eingang innerhalb des Archivs.
public XarEntry CreateEntry(string name, FileInfo fileInfo, bool openImmediately = false, XarCompressionSettings compressionSettings = null)Parameters
name string
Der Name des Eingangs.
fileInfo FileInfo
Die Metadaten von Datei oder Ordner zu komprimieren.
openImmediately bool
Wahrlich, wenn Sie die Datei sofort öffnen, öffnen Sie sonst die Datei auf Archiv-Speicher.
compressionSettings XarCompressionSettings
Die Kompressionseinstellungen verwendet, um das Aspose.Zip.Xar.XarEntry Element hinzuzufügen.
Returns
Eintrittsinstanz von Xar.
Examples
FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
archive.CreateEntry("test.bin", fileInfo);
archive.Save("archive.xar");
}Remarks
Wenn die Datei sofort mit dem Parameter geöffnet wird, wird sie blockiert, bis das Archiv gelöscht wird.
Exceptions
name’ is null.
name’ is empty.
fileInfo’ is null.
CreateEntry(String, String, Bool, XarCompressionSettings)
Erstellen Sie einen einzigen Eingang innerhalb des Archivs.
public XarEntry CreateEntry(string name, string sourcePath, bool openImmediately = false, XarCompressionSettings compressionSettings = null)Parameters
name string
Der Name des Eingangs.
sourcePath string
Der Weg zum Datei zu komprimieren.
openImmediately bool
Wahrlich, wenn Sie die Datei sofort öffnen, öffnen Sie sonst die Datei auf Archiv-Speicher.
compressionSettings XarCompressionSettings
Die Kompressionseinstellungen verwendet, um das Aspose.Zip.Xar.XarEntry Element hinzuzufügen.
Returns
Eintrittsinstanz von Xar.
Examples
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}Remarks
Der im Parameter angegebenen Dateiname beeinflusst nicht den Eingangsnamen.
Wenn die Datei sofort mit dem Parameter geöffnet wird, wird sie blockiert, bis das Archiv gelöscht wird.
Exceptions
sourcePath’ is null.
Der Anrufgeber hat nicht die erforderliche Erlaubnis für den Zugang.
Die sourcePath’ ist leer, enthält nur weiße Räume, oder enthält ungültige Zeichen. - oder - Dateiname, als Teil der name’, übersteigt 100 Symbole.
Der Zugriff auf die Datei sourcePath’ wird abgelehnt.
Die angegebenen sourcePath’, Dateinamen, oder beide überschreiten die Systemdefinierte maximale Länge. Zum Beispiel auf Windows-basierten Plattformen müssen Paths weniger als 248 Zeichen und Dateinamen weniger als 260 Zeichen sein. - oder - name’ ist zu lang für xar.
Die Datei bei sourcePath’ enthält eine Kolonne (:) in der Mitte der Zeile.
Es ist nicht möglich, das ARCHIV zu modifizieren.
CreateEntry(String, Stream, XarCompressionSettings)
Erstellen Sie einen einzigen Eingang innerhalb des Archivs.
public XarEntry CreateEntry(string name, Stream source, XarCompressionSettings compressionSettings = null)Parameters
name string
Der Name des Eingangs.
source Stream
Der Eingangstrom für den Eingang.
compressionSettings XarCompressionSettings
Die Kompressionseinstellungen verwendet, um das Aspose.Zip.Xar.XarEntry Element hinzuzufügen.
Returns
Eintrittsinstanz von Xar.
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.
Es ist nicht möglich, das ARCHIV zu modifizieren.
DeleteEntry(XarEntry)
Entfernen Sie das erste Auftreten eines bestimmten Eintrags aus der Eintragsliste.
public XarArchive DeleteEntry(XarEntry entry)Parameters
entry XarEntry
Eintritt zu entfernen aus der Eintrittsliste.
Returns
Eintrittsinstanz von Xar.
Examples
Hier ist, wie Sie alle Beiträge mit Ausnahme des letzten entfernen können:
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()
Er erfüllt anwendungsdefinierte Aufgaben, die mit der Freisetzung, Freisetzung oder Wiederherstellung unverwalter Ressourcen verbunden sind.
public void Dispose()Dispose(Bool)
Er erfüllt anwendungsdefinierte Aufgaben, die mit der Freisetzung, Freisetzung oder Wiederherstellung unverwalter Ressourcen verbunden sind.
protected virtual void Dispose(bool disposing)Parameters
disposing bool
Ob verwaltete Ressourcen abgeschieden werden sollten.
ExtractToDirectory(String)
Entfernen Sie alle Dateien im Archiv in das angebotene Katalog.
public void ExtractToDirectory(string destinationDirectory)Parameters
destinationDirectory string
Der Weg zum Katalog, um die extrahierten Dateien in.
Examples
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}Remarks
Wenn das Katalog nicht existiert, wird es erstellt.
Exceptions
Der Weg ist null
Die angegebenen Path, Dateinamen oder beide überschreiten die Systemdefinierte maximale Länge. Zum Beispiel müssen auf Windows-basierten Plattformen Paths weniger als 248 Zeichen und Dateinamen weniger als 260 Zeichen sein.
Der Anrufgeber hat nicht die erforderliche Erlaubnis, das bestehende Direktorium zuzugreifen.
Wenn der Direktor nicht existiert, enthält der Pfad einen Zollkarakter (:) der nicht Teil eines Labels ist (“C:”).
Path ist eine nulllänge String, enthält nur weiße Räume, oder enthält einen oder mehrere invalid Charaktere. Sie können für invalid Charaktere anfordern, indem Sie die System.IO.Path.GetInvalidPathChars Methode verwenden. -or- Path ist mit, oder enthält, nur ein Kolon Charakter (:).
Die durch den Weg angegebenen Katalog ist eine Datei. -or- Der Netzwerkname ist nicht bekannt.
Das Archiv ist korrupt.
Save(String, XarSaveOptions)
Speichern Sie das Archiv auf die bereitgestellte Zieldatei.
public void Save(string destinationFileName, XarSaveOptions saveOptions = null)Parameters
destinationFileName string
Wenn der angegebenen Datei-Name auf eine bestehende Datei bezieht, wird sie übergeschrieben.
saveOptions XarSaveOptions
Optionen zur Speicherung von xar Archive mit.
Exceptions
destinationFileName’ is null.
Es ist nicht möglich, das ARCHIV zu modifizieren.
Save(Stream, XarSaveOptions)
Speichern Sie Archive für den bereitgestellten Strom.
public void Save(Stream output, XarSaveOptions saveOptions = null)Parameters
output Stream
Der Destinationstrom.
saveOptions XarSaveOptions
Optionen zur Speicherung von xar Archive mit.
Exceptions
output’ is null.
output’Is not writable/readable or not seekable.
Es ist nicht möglich, das ARCHIV zu modifizieren.
