Class XarArchive

Class XarArchive

Названий на: Aspose.Zip.Xar Асамблея: Aspose.Zip.dll (25.5.0)

Цей клас являє собою архівний файл xar.

public class XarArchive : IArchive, IDisposable

Inheritance

object XarArchive

Implements

IArchive , IDisposable

Нападні члени

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

Constructors

XarArchive(XarCompressionSettings)

Ініціалізація нової інстанції класу Aspose.Zip.Xar.XarArchive.

public XarArchive(XarCompressionSettings defaultCompressionSettings = null)

Parameters

defaultCompressionSettings XarCompressionSettings

Стандартні налаштування компресії, застосовуються до всіх записів в архіві.

Examples

Наступний приклад показує, як компресувати файл.

using (var archive = new XarArchive())
{
    archive.CreateEntry("first.bin", "data.bin");
    archive.Save("archive.xar");
}

XarArchive(Потік, XarLoadOptions)

Ініціалізує нову інстанцію класу Aspose.Zip.Xar.xarАрхів і складає список входів, які можна витягти з архіву.

public XarArchive(Stream sourceStream, XarLoadOptions loadOptions = null)

Parameters

sourceStream Stream

Джерело архіву, його потрібно шукати.

loadOptions XarLoadOptions

Вибір варіантів завантаження архіву.

Examples

Наступний приклад показує, як витягти всі записи в каталог.

using (var archive = new XarArchive(File.OpenRead("archive.xar")))
{
   archive.ExtractToDirectory("C:\\extracted");
}

Remarks

Цей конструктор не депакує жодного входу. переглянути Aspose.Zip.Xar.XarFileEntry.Open метод для депакування.

Exceptions

ArgumentNullException

sourceStream’ is null.

ArgumentException

sourceStream’ is not seekable.

InvalidDataException

sourceStream’ is not valid xar archive.

XarArchive(Завантажити XarLoadOptions)

Ініціалізує нову інстанцію класу Aspose.Zip.Xar.xarАрхів і складає список входів, які можна витягти з архіву.

public XarArchive(string path, XarLoadOptions loadOptions = null)

Parameters

path string

Шлях до архіву.

loadOptions XarLoadOptions

Вибір варіантів завантаження архіву.

Examples

Наступний приклад показує, як витягти всі записи в каталог.

using (var archive = new XarArchive("archive.xar")) 
{
   archive.ExtractToDirectory("C:\\extracted");
}

Remarks

Цей конструктор не депакує жодного входу. переглянути Aspose.Zip.Xar.XarFileEntry.Open метод для депакування.

Exceptions

ArgumentNullException

path’ is null.

SecurityException

Замовник не має необхідного дозволу на доступ.

ArgumentException

path’ є порожнім, містить тільки білі простори, або містить недійсні символи.

UnauthorizedAccessException

Доступ до файлу path" відмовляється.

PathTooLongException

Наприклад, на платформах, заснованих на Windows, шляхи повинні бути менше 248 символів, а імена файлів повинні бути менше 260 символів.

NotSupportedException

Файл в path’ містить колону (:) в середині смуги.

FileNotFoundException

Файл не знайдено.

DirectoryNotFoundException

Визначений шлях недійсний, наприклад, перебування на безкартованому двигуні.

IOException

Файл вже відкритий.

InvalidDataException

Файл в path’ не є дійсним файлом xar.

Properties

Entries

Отримається вхід типу Aspose.Zip.Xar.XarEntry, що складається з архіву.

public IEnumerable<xarentry> Entries { get; }

вартість нерухомості

IEnumerable • < XarEntry >

Methods

CreateEntries(Стриг, буль, XarCompressionSettings)

Додайте до архіву всі файли та каталоги знову і знову в даному каталозі.

public XarArchive CreateEntries(string sourceDirectory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)

Parameters

sourceDirectory string

Керівництво для компресії.

includeRootDirectory bool

Показати, чи включити сам корінний каталог, чи ні.

compressionSettings XarCompressionSettings

Налаштування компресії використовуються для додавання елементів Aspose.Zip.Xar.XarEntry.

Returns

XarArchive

Вхідна інстанція КР.

Examples

using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
    using (var archive = new XarArchive())
    {
        archive.CreateEntries(@"C:\folder", false);
        archive.Save(xarFile);
    }
}

Exceptions

ArgumentNullException

sourceDirectory’ is null.

SecurityException

Зателефонувач не має необхідного дозволу на доступ до sourceDirectory'.

ArgumentException

sourceDirectory’ contains invalid characters such as “, <, >, or |.

PathTooLongException

Наприклад, на платформах, заснованих на Windows, шляхи повинні бути менше 248 символів, а імена файлів повинні бути менше 260 символів.

IOException

sourceDirectory’ stands for a file, not for a directory.

CreateEntries(DirectoryInfo, буль, XarCompressionSettings)

Додайте до архіву всі файли та каталоги знову і знову в даному каталозі.

public XarArchive CreateEntries(DirectoryInfo directory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)

Parameters

directory DirectoryInfo

Керівництво для компресії.

includeRootDirectory bool

Показати, чи включити сам корінний каталог, чи ні.

compressionSettings XarCompressionSettings

Налаштування компресії використовуються для додавання елементів Aspose.Zip.Xar.XarEntry.

Returns

XarArchive

Вхідна інстанція КР.

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

ArgumentNullException

directory’ is null.

SecurityException

Зателефонувач не має необхідного дозволу на доступ до directory”.

IOException

directory’ stands for a file, not for a directory.

CreateEntry(Стриг, FileInfo, Bool, XarCompressionSettings)

Створіть єдиний вхід в архіві.

public XarEntry CreateEntry(string name, FileInfo fileInfo, bool openImmediately = false, XarCompressionSettings compressionSettings = null)

Parameters

name string

Назва входу.

fileInfo FileInfo

Метадани файлу або папки повинні бути компресовані.

openImmediately bool

Правда, якщо відкрити файл відразу, то в іншому випадку відкрити файл на зберігання архіву.

compressionSettings XarCompressionSettings

Налаштування компресії використовуються для додавання елемента Aspose.Zip.Xar.XarEntry.

Returns

XarEntry

Вхідна інстанція КР.

Examples

FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
    archive.CreateEntry("test.bin", fileInfo);
    archive.Save("archive.xar");
}

Remarks

Якщо файл відкривається негайно з параметром, він блокується, поки файл не буде видалений.

Exceptions

ArgumentNullException

name’ is null.

ArgumentException

name’ is empty.

ArgumentNullException

fileInfo’ is null.

CreateEntry(струн, струн, буль, XarCompressionSettings)

Створіть єдиний вхід в архіві.

public XarEntry CreateEntry(string name, string sourcePath, bool openImmediately = false, XarCompressionSettings compressionSettings = null)

Parameters

name string

Назва входу.

sourcePath string

Шлях до файлу, щоб бути компресованим.

openImmediately bool

Правда, якщо відкрити файл відразу, то в іншому випадку відкрити файл на зберігання архіву.

compressionSettings XarCompressionSettings

Налаштування компресії використовуються для додавання елемента Aspose.Zip.Xar.XarEntry.

Returns

XarEntry

Вхідна інстанція КР.

Examples

using (var archive = new XarArchive())
{
    archive.CreateEntry("first.bin", "data.bin");
    archive.Save("archive.xar");
}

Remarks

Назва файлу в параметрі не впливає на ім’я входу.

Якщо файл відкривається негайно з параметром, він блокується, поки файл не буде видалений.

Exceptions

ArgumentNullException

sourcePath’ is null.

SecurityException

Замовник не має необхідного дозволу на доступ.

ArgumentException

sourcePath’ є порожнім, містить тільки білі простори, або містить недійсні символи. - або - Назва файлу, як частина name’, перевищує 100 символів.

UnauthorizedAccessException

Доступ до файлу sourcePath’ відмовляється.

PathTooLongException

Наприклад, на платформах, заснованих на Windows, шляхи повинні бути менше 248 символів, а імена файлів повинні бути менше 260 символів. - або - name’ є занадто довгим для xar.

NotSupportedException

Файл в sourcePath’ містить колону (:) в середині смуги.

InvalidOperationException

Неможливо змінювати архіви.

CreateEntry(Стрий, Стрий, XarCompressionSettings)

Створіть єдиний вхід в архіві.

public XarEntry CreateEntry(string name, Stream source, XarCompressionSettings compressionSettings = null)

Parameters

name string

Назва входу.

source Stream

Вхідний потік для входу.

compressionSettings XarCompressionSettings

Налаштування компресії використовуються для додавання елемента Aspose.Zip.Xar.XarEntry.

Returns

XarEntry

Вхідна інстанція КР.

Examples

using (var archive = new XarArchive())
{
    archive.CreateEntry("data.bin", File.OpenRead("data.bin"));
    archive.Save("archive.xar");
}

Exceptions

ArgumentNullException

name’ is null.

ArgumentNullException

source’ is null.

ArgumentException

name’ is empty.

InvalidOperationException

Неможливо змінювати архіви.

DeleteEntry(XarEntry)

Видаляється перший випадок конкретного входу з списку входів.

public XarArchive DeleteEntry(XarEntry entry)

Parameters

entry XarEntry

Вхід, який потрібно видалити з списку входів.

Returns

XarArchive

Вхідна інстанція КР.

Examples

Ось як ви можете видалити всі записи за винятком останнього:

using (var archive = new XarArchive("archive.xar"))
{
    while (archive.Entries.Count &gt; 1)
        archive.DeleteEntry(archive.Entries.FirstOrDefault());
    archive.Save(outputXarFile);
}

Exceptions

ArgumentNullException

entry’ is null.

Dispose()

Виконання завдань, визначених застосуванням, пов’язаних з звільненням, звільненням або відновленням нерухомих ресурсів.

public void Dispose()

Dispose(Бол)

Виконання завдань, визначених застосуванням, пов’язаних з звільненням, звільненням або відновленням нерухомих ресурсів.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

Чи потрібно витрачати управляні ресурси.

ExtractToDirectory(стрічка)

Витягує всі файли в архіві в наданий каталог.

public void ExtractToDirectory(string destinationDirectory)

Parameters

destinationDirectory string

Шлях до каталогу для розміщення витягнутих файлів.

Examples

using (var archive = new XarArchive("archive.xar")) 
{
   archive.ExtractToDirectory("C:\\extracted");
}

Remarks

Якщо каталог не існує, він буде створений.

Exceptions

ArgumentNullException

Шлях нульовий

PathTooLongException

Наприклад, на платформах, заснованих на Windows, шляхи повинні бути менше 248 символів, а імена файлів повинні бути менше 260 символів.

SecurityException

Зателефонувач не має необхідного дозволу на доступ до існуючого каталогу.

NotSupportedException

Якщо каталог не існує, то шлях містить символ колону (:) який не є частиною етикетки диска (“C:”).

ArgumentException

Шлях - це смуга нульової довжини, містить тільки білий простір, або містить один або кілька недійсних символів. Ви можете запитувати недійсні символи за допомогою методу System.IO.Path.GetInvalidPathChars. -або- Шлях заздалегідь встановлений з, або містить, тільки один символ колону (:).

IOException

Директива, зазначена шляхом, є файлом. -або- Назва мережі не відома.

InvalidDataException

Архів був зруйнований.

Save(Завантажити XarSaveOptions)

Зберегти архіви до даного файлу призначення.

public void Save(string destinationFileName, XarSaveOptions saveOptions = null)

Parameters

destinationFileName string

Якщо назва файлу вказує на існуючий файл, він буде переписаний.

saveOptions XarSaveOptions

Вибір варіантів для збереження файлів xar з.

Exceptions

ArgumentNullException

destinationFileName’ is null.

InvalidOperationException

Неможливо змінювати архіви.

Save(Потік, XarSaveOptions)

Зберегти архіви до наданого потоку.

public void Save(Stream output, XarSaveOptions saveOptions = null)

Parameters

output Stream

Потік напряму.

saveOptions XarSaveOptions

Вибір варіантів для збереження файлів xar з.

Exceptions

ArgumentNullException

output’ is null.

ArgumentException

output’Is not writable/readable or not seekable.

InvalidOperationException

Неможливо змінювати архіви.

 Українська