Class XarArchive
Namespace: Aspose.Zip.Xar
Assembly: Aspose.Zip.dll (25.1.0)
این کلاس نمایانگر فایل آرشیو xar است.
public class XarArchive : IArchive, IDisposable
وراثت
پیادهسازیها
اعضای وراثتیافته
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
سازندهها
XarArchive(XarCompressionSettings)
یک نمونه جدید از کلاس Aspose.Zip.Xar.XarArchive را راهاندازی میکند.
public XarArchive(XarCompressionSettings defaultCompressionSettings = null)
پارامترها
defaultCompressionSettings
XarCompressionSettings
تنظیمات فشردهسازی پیشفرض که به تمام ورودیهای آرشیو اعمال میشود.
مثالها
مثال زیر نشان میدهد که چگونه یک فایل را فشرده کنیم.
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}
XarArchive(Stream, XarLoadOptions)
یک نمونه جدید از کلاس Aspose.Zip.Xar.XarArchive را راهاندازی کرده و لیست ورودیهایی که میتوان از آرشیو استخراج کرد را تشکیل میدهد.
public XarArchive(Stream sourceStream, XarLoadOptions loadOptions = null)
پارامترها
sourceStream
Stream
منبع آرشیو. باید قابل جستجو باشد.
loadOptions
XarLoadOptions
گزینههایی برای بارگذاری آرشیو.
مثالها
مثال زیر نشان میدهد که چگونه تمام ورودیها را به یک دایرکتوری استخراج کنیم.
using (var archive = new XarArchive(File.OpenRead("archive.xar")))
{
archive.ExtractToDirectory("C:\\extracted");
}
توضیحات
این سازنده هیچ ورودی را بستهبندی نمیکند. برای بستهبندی به متد Aspose.Zip.Xar.XarFileEntry.Open مراجعه کنید.
استثناها
sourceStream
نال است.
sourceStream
قابل جستجو نیست.
sourceStream
یک آرشیو xar معتبر نیست.
XarArchive(string, XarLoadOptions)
یک نمونه جدید از کلاس Aspose.Zip.Xar.XarArchive را راهاندازی کرده و لیست ورودیهایی که میتوان از آرشیو استخراج کرد را تشکیل میدهد.
public XarArchive(string path, XarLoadOptions loadOptions = null)
پارامترها
path
string
مسیر به فایل آرشیو.
loadOptions
XarLoadOptions
گزینههایی برای بارگذاری آرشیو.
مثالها
مثال زیر نشان میدهد که چگونه تمام ورودیها را به یک دایرکتوری استخراج کنیم.
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}
توضیحات
این سازنده هیچ ورودی را بستهبندی نمیکند. برای بستهبندی به متد Aspose.Zip.Xar.XarFileEntry.Open مراجعه کنید.
استثناها
path
نال است.
فراخوانیکننده مجوز لازم برای دسترسی را ندارد.
path
خالی است، فقط شامل فضای خالی است، یا شامل کاراکترهای نامعتبر است.
دسترسی به فایل path
ممنوع است.
path
، نام فایل، یا هر دو از حداکثر طول تعریف شده توسط سیستم بیشتر است. به عنوان مثال، در پلتفرمهای مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایلها باید کمتر از 260 کاراکتر باشد.
فایل در path
شامل یک دو نقطه (:) در وسط رشته است.
فایل پیدا نشد.
مسیر مشخص شده نامعتبر است، مانند اینکه در یک درایو نامشخص باشد.
فایل قبلاً باز است.
فایل در path
یک آرشیو xar معتبر نیست.
ویژگیها
Entries
ورودیهای نوع Aspose.Zip.Xar.XarEntry را که آرشیو را تشکیل میدهند، دریافت میکند.
public IEnumerable<xarentry> Entries { get; }
مقدار ویژگی
IEnumerable<XarEntry>
متدها
CreateEntries(string, bool, XarCompressionSettings)
به آرشیو تمام فایلها و دایرکتوریها را به صورت بازگشتی در دایرکتوری داده شده اضافه میکند.
public XarArchive CreateEntries(string sourceDirectory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)
پارامترها
sourceDirectory
string
دایرکتوری برای فشردهسازی.
includeRootDirectory
bool
نشان میدهد که آیا دایرکتوری ریشه خود را شامل شود یا خیر.
compressionSettings
XarCompressionSettings
تنظیمات فشردهسازی استفاده شده برای افزودن موارد Aspose.Zip.Xar.XarEntry.
بازگشت
نمونه ورودی Xar.
مثالها
using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
using (var archive = new XarArchive())
{
archive.CreateEntries(@"C:\folder", false);
archive.Save(xarFile);
}
}
استثناها
sourceDirectory
نال است.
فراخوانیکننده مجوز لازم برای دسترسی به sourceDirectory
را ندارد.
sourceDirectory
شامل کاراکترهای نامعتبر مانند “, <, >، یا | است.
مسیر، نام فایل، یا هر دو از حداکثر طول تعریف شده توسط سیستم بیشتر است. به عنوان مثال، در پلتفرمهای مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایلها باید کمتر از 260 کاراکتر باشد. مسیر، نام فایل، یا هر دو خیلی طولانی هستند.
sourceDirectory
نمایانگر یک فایل است، نه یک دایرکتوری.
CreateEntries(DirectoryInfo, bool, XarCompressionSettings)
به آرشیو تمام فایلها و دایرکتوریها را به صورت بازگشتی در دایرکتوری داده شده اضافه میکند.
public XarArchive CreateEntries(DirectoryInfo directory, bool includeRootDirectory = true, XarCompressionSettings compressionSettings = null)
پارامترها
directory
DirectoryInfo
دایرکتوری برای فشردهسازی.
includeRootDirectory
bool
نشان میدهد که آیا دایرکتوری ریشه خود را شامل شود یا خیر.
compressionSettings
XarCompressionSettings
تنظیمات فشردهسازی استفاده شده برای افزودن موارد Aspose.Zip.Xar.XarEntry.
بازگشت
نمونه ورودی Xar.
مثالها
using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
using (var archive = new XarArchive())
{
archive.CreateEntries(new DirectoryInfo(@"C:\folder"), false);
archive.Save(xarFile);
}
}
استثناها
directory
نال است.
فراخوانیکننده مجوز لازم برای دسترسی به directory
را ندارد.
directory
نمایانگر یک فایل است، نه یک دایرکتوری.
CreateEntry(string, FileInfo, bool, XarCompressionSettings)
یک ورودی واحد درون آرشیو ایجاد میکند.
public XarEntry CreateEntry(string name, FileInfo fileInfo, bool openImmediately = false, XarCompressionSettings compressionSettings = null)
پارامترها
name
string
نام ورودی.
fileInfo
FileInfo
متاداده فایل یا پوشهای که باید فشرده شود.
openImmediately
bool
در صورتی که بلافاصله فایل را باز کند، درست است، در غیر این صورت فایل در زمان ذخیره آرشیو باز میشود.
compressionSettings
XarCompressionSettings
تنظیمات فشردهسازی استفاده شده برای افزودن مورد Aspose.Zip.Xar.XarEntry.
بازگشت
نمونه ورودی Xar.
مثالها
FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
archive.CreateEntry("test.bin", fileInfo);
archive.Save("archive.xar");
}
توضیحات
اگر فایل بلافاصله با پارامتر openImmediately
باز شود، تا زمان از بین بردن آرشیو مسدود میشود.
استثناها
name
نال است.
name
خالی است.
fileInfo
نال است.
CreateEntry(string, string, bool, XarCompressionSettings)
یک ورودی واحد درون آرشیو ایجاد میکند.
public XarEntry CreateEntry(string name, string sourcePath, bool openImmediately = false, XarCompressionSettings compressionSettings = null)
پارامترها
name
string
نام ورودی.
sourcePath
string
مسیر به فایلی که باید فشرده شود.
openImmediately
bool
در صورتی که بلافاصله فایل را باز کند، درست است، در غیر این صورت فایل در زمان ذخیره آرشیو باز میشود.
compressionSettings
XarCompressionSettings
تنظیمات فشردهسازی استفاده شده برای افزودن مورد Aspose.Zip.Xar.XarEntry.
بازگشت
نمونه ورودی Xar.
مثالها
using (var archive = new XarArchive())
{
archive.CreateEntry("first.bin", "data.bin");
archive.Save("archive.xar");
}
توضیحات
نام ورودی به طور کامل درون پارامتر name
تنظیم میشود. نام فایلی که در پارامتر sourcePath
ارائه شده تأثیری بر نام ورودی ندارد.
اگر فایل بلافاصله با پارامتر openImmediately
باز شود، تا زمان از بین بردن آرشیو مسدود میشود.
استثناها
sourcePath
نال است.
فراخوانیکننده مجوز لازم برای دسترسی را ندارد.
sourcePath
خالی است، فقط شامل فضای خالی است، یا شامل کاراکترهای نامعتبر است. - یا - نام فایل، به عنوان بخشی از name
، بیشتر از 100 نماد است.
دسترسی به فایل sourcePath
ممنوع است.
sourcePath
، نام فایل، یا هر دو از حداکثر طول تعریف شده توسط سیستم بیشتر است. به عنوان مثال، در پلتفرمهای مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایلها باید کمتر از 260 کاراکتر باشد. - یا - name
برای xar خیلی طولانی است.
فایل در sourcePath
شامل یک دو نقطه (:) در وسط رشته است.
امکان تغییر آرشیو xar وجود ندارد.
CreateEntry(string, Stream, XarCompressionSettings)
یک ورودی واحد درون آرشیو ایجاد میکند.
public XarEntry CreateEntry(string name, Stream source, XarCompressionSettings compressionSettings = null)
پارامترها
name
string
نام ورودی.
source
Stream
جریان ورودی برای ورودی.
compressionSettings
XarCompressionSettings
تنظیمات فشردهسازی استفاده شده برای افزودن مورد Aspose.Zip.Xar.XarEntry.
بازگشت
نمونه ورودی Xar.
مثالها
using (var archive = new XarArchive())
{
archive.CreateEntry("data.bin", File.OpenRead("data.bin"));
archive.Save("archive.xar");
}
استثناها
name
نال است.
source
نال است.
name
خالی است.
امکان تغییر آرشیو xar وجود ندارد.
DeleteEntry(XarEntry)
اولین وقوع یک ورودی خاص را از لیست ورودیها حذف میکند.
public XarArchive DeleteEntry(XarEntry entry)
پارامترها
entry
XarEntry
ورودی که باید از لیست ورودیها حذف شود.
بازگشت
نمونه ورودی Xar.
مثالها
در اینجا نشان میدهد که چگونه میتوانید تمام ورودیها را به جز آخرین ورودی حذف کنید:
using (var archive = new XarArchive("archive.xar"))
{
while (archive.Entries.Count > 1)
archive.DeleteEntry(archive.Entries.FirstOrDefault());
archive.Save(outputXarFile);
}
استثناها
entry
نال است.
Dispose()
وظایف تعریف شده توسط برنامه را که مربوط به آزادسازی، رها کردن یا بازنشانی منابع غیرمدیریتی است، انجام میدهد.
public void Dispose()
Dispose(bool)
وظایف تعریف شده توسط برنامه را که مربوط به آزادسازی، رها کردن یا بازنشانی منابع غیرمدیریتی است، انجام میدهد.
protected virtual void Dispose(bool disposing)
پارامترها
disposing
bool
آیا منابع مدیریتی باید رها شوند یا خیر.
ExtractToDirectory(string)
تمام فایلها را در آرشیو به دایرکتوری ارائه شده استخراج میکند.
public void ExtractToDirectory(string destinationDirectory)
پارامترها
destinationDirectory
string
مسیر به دایرکتوری برای قرار دادن فایلهای استخراج شده.
مثالها
using (var archive = new XarArchive("archive.xar"))
{
archive.ExtractToDirectory("C:\\extracted");
}
توضیحات
اگر دایرکتوری وجود نداشته باشد، ایجاد خواهد شد.
استثناها
مسیر نال است.
مسیر مشخص شده، نام فایل، یا هر دو از حداکثر طول تعریف شده توسط سیستم بیشتر است. به عنوان مثال، در پلتفرمهای مبتنی بر ویندوز، مسیرها باید کمتر از 248 کاراکتر و نام فایلها باید کمتر از 260 کاراکتر باشد.
فراخوانیکننده مجوز لازم برای دسترسی به دایرکتوری موجود را ندارد.
اگر دایرکتوری وجود نداشته باشد، مسیر شامل یک کاراکتر دو نقطه (:) است که بخشی از برچسب درایو نیست (“C:") .
مسیر یک رشته با طول صفر است، فقط شامل فضای خالی است، یا شامل یک یا چند کاراکتر نامعتبر است. میتوانید با استفاده از متد System.IO.Path.GetInvalidPathChars کاراکترهای نامعتبر را جستجو کنید. - یا - مسیر با، یا شامل، فقط یک کاراکتر دو نقطه (:) است.
دایرکتوری مشخص شده توسط مسیر یک فایل است. - یا - نام شبکه شناخته شده نیست.
آرشیو خراب است.
Save(string, XarSaveOptions)
آرشیو را به فایل مقصد ارائه شده ذخیره میکند.
public void Save(string destinationFileName, XarSaveOptions saveOptions = null)
پارامترها
destinationFileName
string
مسیر آرشیو که باید ایجاد شود. اگر نام فایل مشخص شده به یک فایل موجود اشاره کند، بر روی آن بازنویسی خواهد شد.
saveOptions
XarSaveOptions
گزینههایی برای ذخیره آرشیو xar.
استثناها
destinationFileName
نال است.
امکان تغییر آرشیو xar وجود ندارد.
Save(Stream, XarSaveOptions)
آرشیو را به جریان ارائه شده ذخیره میکند.
public void Save(Stream output, XarSaveOptions saveOptions = null)
پارامترها
output
Stream
جریان مقصد.
saveOptions
XarSaveOptions
گزینههایی برای ذخیره آرشیو xar.
استثناها
output
نال است.
output
قابل نوشتن/خواندن نیست یا قابل جستجو نیست.
امکان تغییر آرشیو xar وجود ندارد.