Class XarArchive
Название пространства: Aspose.Zip.Xar Ассоциация: Aspose.Zip.dll (25.5.0)
Этот класс представляет собой файл архива xar.
public class XarArchive : IArchive, IDisposable
Inheritance
Implements
Наследованные члены
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.xarArchive и составляет входный список, который можно извлечь из архива.
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
sourceStream’ is null.
sourceStream’ is not seekable.
sourceStream’ is not valid xar archive.
XarArchive(Сердце, XarLoadOptions)
Инициализует новую инстанцию класса Aspose.Zip.Xar.xarArchive и составляет входный список, который можно извлечь из архива.
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
path’ is null.
Заказчик не имеет требуемого разрешения на доступ.
path" пустая, содержит только белые пространства или содержит недействительные символы.
Доступ к файлу path" отказывается.
Указанный path", имя файла, или оба превышают максимальную длину, установленную системой. Например, на платформах на базе Windows, пути должны быть менее 248 символов, а имена файлов должны быть менее 260 символов.
Файл в path’ содержит колону (:) в середине строки.
Файл не найден.
Указанный маршрут является недействительным, например, находиться на немапированном диске.
Файл уже открыт.
Файл в 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
Вход в инстанцию.
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.
Вызовчик не имеет требуемого разрешения на доступ к sourceDirectory'.
sourceDirectory’ contains invalid characters such as “, <, >, or |.
Например, на платформах на базе Windows, пути должны быть менее 248 символов, а имена файлов должны быть менее 260 символов.
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
Вход в инстанцию.
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.
Вызовчик не имеет требуемого разрешения на доступ к directory”.
directory’ stands for a file, not for a directory.
CreateEntry(string, 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
Вход в инстанцию.
Examples
FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
archive.CreateEntry("test.bin", fileInfo);
archive.Save("archive.xar");
}
Remarks
Если файл открывается немедленно с параметром, он блокируется до того момента, пока файл не будет удален.
Exceptions
name’ is null.
name’ is empty.
fileInfo’ is null.
CreateEntry(string, string, bool, 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
Вход в инстанцию.
Examples
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}
Remarks
Название входа устанавливается только в пределах параметра.Название файла, предоставленное в параметре, не влияет на имя входа.
Если файл открывается немедленно с параметром, он блокируется до того момента, пока файл не будет удален.
Exceptions
sourcePath’ is null.
Заказчик не имеет требуемого разрешения на доступ.
sourcePath’ является пустым, содержит только белые пространства, или содержит недействительные символы. - или - Название файла, как часть
name’, превышает 100 символов.
Доступ к файлу sourcePath" отказывается.
Определенный sourcePath’, имя файла, или оба превышают максимальную длину, установленную системой. Например, на платформах на базе Windows, пути должны быть менее 248 символов, а имена файлов должны быть менее 260 символов. - или -
name’ слишком длинный для xar.
Файл в sourcePath’ содержит колону (:) в середине строки.
Нельзя модифицировать архивы.
CreateEntry(Стриг, Stream, XarCompressionSettings)
Создайте единый вход в архиве.
public XarEntry CreateEntry(string name, Stream source, XarCompressionSettings compressionSettings = null)
Parameters
name
string
Название входа.
source
Stream
Входный поток для входа.
compressionSettings
XarCompressionSettings
Настройки компрессии используются для добавления элемента Aspose.Zip.Xar.XarEntry.
Returns
Вход в инстанцию.
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.
Нельзя модифицировать архивы.
DeleteEntry(XarEntry)
Удаляется первое появление конкретного входа из списка входов.
public XarArchive DeleteEntry(XarEntry entry)
Parameters
entry
XarEntry
Вход, который нужно удалить из списка входов.
Returns
Вход в инстанцию.
Examples
Вот как вы можете удалить все записи, за исключением последней:
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()
Осуществляет задания, определенные приложением, связанные с освобождением, освобождением или восстановлением неконтролируемых ресурсов.
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
Путь нулевой
Например, на платформах, основанных на Windows, маршруты должны быть менее 248 символов, а имена файлов должны быть менее 260 символов.
Заклинатель не имеет требуемого разрешения на доступ к существующему каталогу.
Если каталог не существует, то маршрут содержит колонный характер (:) который не является частью дисковой маркировки («C:»).
Путь - это строка с нулевой длиной, содержит только белое пространство, или содержит один или несколько недействительных символов. Вы можете запросить недействительные символы, используя метод System.IO.Path.GetInvalidPathChars. -или- Путь предварительно фиксирован с, или содержит, только один колонный символ (:).
Каталог, указанный по маршруту, является файлом. -или- Название сети неизвестно.
Архив был коррумпирован.
Save(Оригинальное название: XarSaveOptions)
Сохранить архив до предоставленного целевого файла.
public void Save(string destinationFileName, XarSaveOptions saveOptions = null)
Parameters
destinationFileName
string
Если указанное имя файла указывает на существующий файл, оно будет переписано.
saveOptions
XarSaveOptions
Опции для сохранения архивов xar с.
Exceptions
destinationFileName’ is null.
Нельзя модифицировать архивы.
Save(Поток, XarSaveOptions)
Сохранить архив в предоставленный поток.
public void Save(Stream output, XarSaveOptions saveOptions = null)
Parameters
output
Stream
Достопримечательности потока.
saveOptions
XarSaveOptions
Опции для сохранения архивов xar с.
Exceptions
output’ is null.
output’Is not writable/readable or not seekable.
Нельзя модифицировать архивы.