Class XarArchive

sourceStream’ is not seekable.

InvalidDataException

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.

召唤者没有所需的访问许可。

UnauthorizedAccessException

path’ 是空的,只包含白色空间,或包含无效的字符。

拒绝访问 path" 文件。

DirectoryNotFoundException

指定的 path’, 文件名, 或两者都超过系统定义的最大长度. 例如,在基于 Windows 的平台上,路径必须小于 248 个字符, 文件名必须小于 260 个字符。

NotSupportedException

文件在 path’ 中间包含一个列(:)。

FileNotFoundException

文件未找到。

指定的路径是无效的,例如在无地图驱动器上。

文件已经开放了。

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`

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, bool, XarCompression 设置)`

将所有文件和目录重复添加到存档中。

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`

directory’ is null.

通话者没有必要的许可访问 directory。

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`

name’ is null.

name’ is empty.

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`

sourcePath’ is null.

召唤者没有所需的访问许可。

UnauthorizedAccessException

sourcePath’ 是空的,只包含白色空间,或包含无效的字符. - 或 - 文件名,作为 name’ 的部分,超过 100 个符号。

拒绝访问 sourcePath’ 文件。

指定的 sourcePath’, 文件名, 或两者都超过系统定义的最大长度. 例如,在基于 Windows 的平台上,路径必须小于 248 个字符, 文件名必须小于 260 个字符。

NotSupportedException

文件在 sourcePath’ 中间包含一个列(:)。

无法修改 xar 档案。

`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`

name’ is null.

source’ is null.

name’ is empty.

无法修改 xar 档案。

`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`

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 个字符。

呼叫者没有必要的许可访问现有目录。

NotSupportedException

如果目录不存在,路径包含一个列符(:)不属于驱动标签(“C:”)的一部分。

路径是零长的线条,仅包含白空间,或包含一个或多个无效的字符. 您可以使用 System.IO.Path.GetInvalidPathChars 方法查询无效的字符。

路径指定的目录是一个文件. -or- 网络名称不明。

InvalidDataException

档案被腐败了。

`Save(字符串, XarSaveOptions)`

存储到所提供的目的地文件的档案。

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

`Parameters`

destinationFileName string

要创建档案的路径如果指定的文件名指向现有文件,则将重写。

saveOptions XarSaveOptions

存储 xar 档案的选项。

`Exceptions`

destinationFileName’ is null.

无法修改 xar 档案。

`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.