Class XzArchive

Class XzArchive

Namespace: Aspose.Zip.Xz
Assembly: Aspose.Zip.dll (25.1.0)

このクラスは xz アーカイブファイルを表します。xz アーカイブを作成および抽出するために使用します。

public class XzArchive : IArchive, IDisposable, IArchiveFileEntry

継承

objectXzArchive

実装

IArchive, IDisposable, IArchiveFileEntry

継承されたメンバー

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

コンストラクター

XzArchive(XzArchiveSettings)

Aspose.Zip.Xz.XzArchive クラスの新しいインスタンスを初期化し、xz 形式でアーカイブを作成します。

public XzArchive(XzArchiveSettings settings = null)

パラメーター

settings XzArchiveSettings

特定の xz アーカイブの設定のセット: 辞書サイズ、ブロックサイズ、チェックタイプ。

XzArchive(Stream)

解凍のために準備された Aspose.Zip.Xz.XzArchive クラスの新しいインスタンスを初期化します。

public XzArchive(Stream source)

パラメーター

source Stream

アーカイブのソース。

備考

このコンストラクターは解凍を行いません。解凍のためには Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) メソッドを参照してください。

例外

ArgumentException

source はシーク可能ではありません。

ArgumentNullException

source は null です。

XzArchive(string)

解凍のために準備された Aspose.Zip.Xz.XzArchive クラスの新しいインスタンスを初期化します。

public XzArchive(string path)

パラメーター

path string

アーカイブのソースへのパス。

備考

このコンストラクターは解凍を行いません。解凍のためには Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) メソッドを参照してください。

例外

ArgumentNullException

path は null です。

SecurityException

呼び出し元はアクセスするための必要な権限を持っていません。

ArgumentException

path は空であるか、空白のみを含むか、無効な文字を含んでいます。

UnauthorizedAccessException

ファイル path へのアクセスが拒否されました。

PathTooLongException

指定された path、ファイル名、または両方がシステム定義の最大長を超えています。たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満、ファイル名は 260 文字未満である必要があります。

NotSupportedException

path に文字列の途中にコロン (:) が含まれています。

FileNotFoundException

ファイルが見つかりません。

DirectoryNotFoundException

指定されたパスが無効であり、マッピングされていないドライブにある場合などです。

IOException

ファイルはすでに開かれています。

メソッド

Dispose()

アンマネージリソースを解放、開放、またはリセットするために関連付けられたアプリケーション定義のタスクを実行します。

public void Dispose()

Dispose(bool)

アンマネージリソースを解放、開放、またはリセットするために関連付けられたアプリケーション定義のタスクを実行します。

protected virtual void Dispose(bool disposing)

パラメーター

disposing bool

マネージリソースを解放する必要があるかどうか。

Extract(Stream)

xz アーカイブをストリームに抽出します。

public void Extract(Stream destination)

パラメーター

destination Stream

解凍されたデータを保存するためのストリーム。

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (FileStream extractedFile = File.Open(extractedFileName, FileMode.Create))
    {
        using (var archive = new XzArchive(xzFile))
        {
            archive.Extract(extractedFile);
        }
    }
}

例外

InvalidOperationException

アーカイブヘッダーとサービス情報が読み取られていません。

Extract(FileInfo)

xz アーカイブをファイルに抽出します。

public void Extract(FileInfo fileInfo)

パラメーター

fileInfo FileInfo

解凍されたデータを保存するための FileInfo。

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (var archive = new XzArchive(xzFile))
    {
        archive.Extract(new FileInfo("extracted.bin"));
    }
}

例外

InvalidOperationException

アーカイブヘッダーとサービス情報が読み取られていません。

SecurityException

呼び出し元は fileInfo を開くための必要な権限を持っていません。

ArgumentException

ファイルパスが空であるか、空白のみを含んでいます。

FileNotFoundException

ファイルが見つかりません。

UnauthorizedAccessException

ファイルへのパスが読み取り専用またはディレクトリです。

ArgumentNullException

fileInfo は null です。

DirectoryNotFoundException

指定されたパスが無効であり、マッピングされていないドライブにある場合などです。

IOException

ファイルはすでに開かれています。

Extract(string)

パスによって xz アーカイブをファイルに抽出します。

public FileInfo Extract(string path)

パラメーター

path string

解凍されたデータを保存するファイルへのパス。

戻り値

FileInfo

抽出されたデータを含む System.IO.FileInfo インスタンス。

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (var archive = new XzArchive(xzFile))
    {
        archive.Extract("extracted.bin");
    }
}

例外

InvalidOperationException

アーカイブヘッダーとサービス情報が読み取られていません。

ArgumentNullException

path は null です。

SecurityException

呼び出し元はアクセスするための必要な権限を持っていません。

ArgumentException

path は空であるか、空白のみを含むか、無効な文字を含んでいます。

UnauthorizedAccessException

ファイル path へのアクセスが拒否されました。

PathTooLongException

指定された path、ファイル名、または両方がシステム定義の最大長を超えています。たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満、ファイル名は 260 文字未満である必要があります。

NotSupportedException

path に文字列の途中にコロン (:) が含まれています。

FileNotFoundException

ファイルが見つかりません。

DirectoryNotFoundException

指定されたパスが無効であり、マッピングされていないドライブにある場合などです。

IOException

ファイルはすでに開かれています。

ExtractToDirectory(string)

アーカイブの内容を指定されたディレクトリに抽出します。

public void ExtractToDirectory(string destinationDirectory)

パラメーター

destinationDirectory string

抽出されたファイルを配置するディレクトリへのパス。

備考

ディレクトリが存在しない場合は、作成されます。

例外

ArgumentNullException

destinationDirectory は null です。

PathTooLongException

指定されたパス、ファイル名、または両方がシステム定義の最大長を超えています。たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満、ファイル名は 260 文字未満である必要があります。

SecurityException

呼び出し元は既存のディレクトリにアクセスするための必要な権限を持っていません。

NotSupportedException

ディレクトリが存在しない場合、パスにはドライブラベル (“C:") の一部でないコロン文字 (:) が含まれています。

ArgumentException

destinationDirectory はゼロ長の文字列であるか、空白のみを含むか、無効な文字の 1 つ以上を含んでいます。無効な文字を照会するには、System.IO.Path.GetInvalidPathChars メソッドを使用できます。 -または- パスがコロン文字 (:) で始まるか、コロン文字 (:) のみを含んでいます。

IOException

指定されたパスのディレクトリがファイルです。 -または- ネットワーク名が不明です。

Save(Stream)

指定されたストリームに xz アーカイブを保存します。

public void Save(Stream output)

パラメーター

output Stream

宛先ストリーム。

using (FileStream xzFile = File.Open("archive.xz", FileMode.Create))
{
    using (var archive = new XzArchive())
    {
        archive.SetSource("data.bin");
        archive.Save(xzFile);
     }
}

備考

output はシーク可能でなければなりません。

例外

ArgumentException

output はシークをサポートしていません。

ArgumentNullException

output は null です。

Save(string)

指定された宛先ファイルに xz アーカイブを保存します。

public void Save(string destinationFileName)

パラメーター

destinationFileName string

作成されるアーカイブのパス。指定されたファイル名が既存のファイルを指す場合は、上書きされます。

using (var archive = new XzArchive()) 
{
    archive.SetSource(new FileInfo("data.bin"));
    archive.Save("result.xz");
}

例外

ArgumentNullException

destinationFileName は null です。

SecurityException

呼び出し元はアクセスするための必要な権限を持っていません。

ArgumentException

destinationFileName は空であるか、空白のみを含むか、無効な文字を含んでいます。

UnauthorizedAccessException

ファイル destinationFileName へのアクセスが拒否されました。

PathTooLongException

指定された destinationFileName、ファイル名、または両方がシステム定義の最大長を超えています。たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満、ファイル名は 260 文字未満である必要があります。

NotSupportedException

destinationFileName に文字列の途中にコロン (:) が含まれています。

SetSource(Stream)

アーカイブ内で圧縮されるコンテンツを設定します。

public void SetSource(Stream source)

パラメーター

source Stream

アーカイブの入力ストリーム。

using (var archive = new XzArchive())
{
    archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
    archive.Save("archive.xz");
}

例外

ArgumentException

source ストリームはシーク可能ではありません。

SetSource(FileInfo)

アーカイブ内で圧縮されるコンテンツを設定します。

public void SetSource(FileInfo fileInfo)

パラメーター

fileInfo FileInfo

入力ストリームとして開かれる FileInfo。

using (var archive = new XzArchive()) 
{
    archive.SetSource(new FileInfo("data.bin"));
    archive.Save("archive.xz");
}

例外

SecurityException

呼び出し元は fileInfo を開くための必要な権限を持っていません。

ArgumentException

ファイルパスが空であるか、空白のみを含んでいます。

FileNotFoundException

ファイルが見つかりません。

UnauthorizedAccessException

ファイルへのパスが読み取り専用またはディレクトリです。

ArgumentNullException

fileInfo は null です。

DirectoryNotFoundException

指定されたパスが無効であり、マッピングされていないドライブにある場合などです。

IOException

ファイルはすでに開かれています。

SetSource(string)

アーカイブ内で圧縮されるコンテンツを設定します。

public void SetSource(string sourcePath)

パラメーター

sourcePath string

入力ストリームとして開かれるファイルへのパス。

using (var archive = new XzArchive()) 
{
    archive.SetSource("data.bin");
    archive.Save("archive.xz");
}

例外

ArgumentNullException

sourcePath は null です。

SecurityException

呼び出し元はアクセスするための必要な権限を持っていません。

ArgumentException

sourcePath は空であるか、空白のみを含むか、無効な文字を含んでいます。

UnauthorizedAccessException

ファイル sourcePath へのアクセスが拒否されました。

PathTooLongException

指定された sourcePath、ファイル名、または両方がシステム定義の最大長を超えています。たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満、ファイル名は 260 文字未満である必要があります。

NotSupportedException

sourcePath に文字列の途中にコロン (:) が含まれています。

 日本語