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 تهی است.

XzArchive(string)

یک نمونه جدید از کلاس Aspose.Zip.Xz.XzArchive را برای استخراج آماده می‌کند.

public XzArchive(string path)

پارامترها

path string

مسیر به منبع آرشیو.

توضیحات

این سازنده استخراج نمی‌کند. برای استخراج، به متد Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) مراجعه کنید.

استثناها

ArgumentNullException

path تهی است.

SecurityException

فراخوانی‌کننده مجوز لازم برای دسترسی را ندارد.

ArgumentException

path خالی است، فقط شامل فضاهای خالی است یا شامل کاراکترهای نامعتبر است.

UnauthorizedAccessException

دسترسی به فایل path رد شده است.

PathTooLongException

path، نام فایل، یا هر دو از حداکثر طول تعریف‌شده توسط سیستم فراتر رفته‌اند. به عنوان مثال، در سیستم‌عامل‌های مبتنی بر ویندوز، مسیرها باید کمتر از 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 تهی است.

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 تهی است.

SecurityException

فراخوانی‌کننده مجوز لازم برای دسترسی را ندارد.

ArgumentException

path خالی است، فقط شامل فضاهای خالی است یا شامل کاراکترهای نامعتبر است.

UnauthorizedAccessException

دسترسی به فایل path رد شده است.

PathTooLongException

path، نام فایل، یا هر دو از حداکثر طول تعریف‌شده توسط سیستم فراتر رفته‌اند. به عنوان مثال، در سیستم‌عامل‌های مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایل‌ها باید کمتر از 260 کاراکتر باشند.

NotSupportedException

فایل در path شامل یک دو نقطه (:) در وسط رشته است.

FileNotFoundException

فایل پیدا نشد.

DirectoryNotFoundException

مسیر مشخص‌شده نامعتبر است، مانند اینکه در یک درایو نامنقشه باشد.

IOException

فایل در حال حاضر باز است.

ExtractToDirectory(string)

محتویات آرشیو را به دایرکتوری ارائه‌شده استخراج می‌کند.

public void ExtractToDirectory(string destinationDirectory)

پارامترها

destinationDirectory string

مسیر به دایرکتوری که فایل‌های استخراج‌شده در آن قرار می‌گیرند.

توضیحات

اگر دایرکتوری وجود نداشته باشد، ایجاد خواهد شد.

استثناها

ArgumentNullException

destinationDirectory تهی است.

PathTooLongException

path، نام فایل، یا هر دو از حداکثر طول تعریف‌شده توسط سیستم فراتر رفته‌اند. به عنوان مثال، در سیستم‌عامل‌های مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایل‌ها باید کمتر از 260 کاراکتر باشند.

SecurityException

فراخوانی‌کننده مجوز لازم برای دسترسی به دایرکتوری موجود را ندارد.

NotSupportedException

اگر دایرکتوری وجود نداشته باشد، مسیر شامل یک کاراکتر دو نقطه (:) است که بخشی از برچسب درایو نیست (“C:").

ArgumentException

destinationDirectory یک رشته با طول صفر است، فقط شامل فضاهای خالی است یا شامل یک یا چند کاراکتر نامعتبر است. می‌توانید با استفاده از متد 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 تهی است.

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 تهی است.

SecurityException

فراخوانی‌کننده مجوز لازم برای دسترسی را ندارد.

ArgumentException

destinationFileName خالی است، فقط شامل فضاهای خالی است یا شامل کاراکترهای نامعتبر است.

UnauthorizedAccessException

دسترسی به فایل destinationFileName رد شده است.

PathTooLongException

destinationFileName، نام فایل، یا هر دو از حداکثر طول تعریف‌شده توسط سیستم فراتر رفته‌اند. به عنوان مثال، در سیستم‌عامل‌های مبتنی بر ویندوز، مسیرها باید کمتر از 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 تهی است.

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 تهی است.

SecurityException

فراخوانی‌کننده مجوز لازم برای دسترسی را ندارد.

ArgumentException

sourcePath خالی است، فقط شامل فضاهای خالی است یا شامل کاراکترهای نامعتبر است.

UnauthorizedAccessException

دسترسی به فایل sourcePath رد شده است.

PathTooLongException

sourcePath، نام فایل، یا هر دو از حداکثر طول تعریف‌شده توسط سیستم فراتر رفته‌اند. به عنوان مثال، در سیستم‌عامل‌های مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایل‌ها باید کمتر از 260 کاراکتر باشند.

NotSupportedException

فایل در sourcePath شامل یک دو نقطه (:) در وسط رشته است.

 فارسی