Class XarArchive

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

تمثل هذه الفئة ملف أرشيف xar.

public class XarArchive : IArchive, IDisposable

الوراثة

object ← 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 لفك الضغط.

الاستثناءات

ArgumentNullException

sourceStream هو null.

ArgumentException

sourceStream ليس قابلًا للبحث.

InvalidDataException

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 لفك الضغط.

الاستثناءات

ArgumentNullException

path هو null.

SecurityException

لا يمتلك المتصل الإذن المطلوب للوصول.

ArgumentException

path فارغ، يحتوي فقط على مسافات بيضاء، أو يحتوي على أحرف غير صالحة.

UnauthorizedAccessException

تم رفض الوصول إلى ملف path.

PathTooLongException

تجاوز path أو اسم الملف، أو كليهما، الطول الأقصى المحدد بواسطة النظام. على سبيل المثال، في الأنظمة المعتمدة على ويندوز، يجب أن تكون المسارات أقل من 248 حرفًا، ويجب أن تكون أسماء الملفات أقل من 260 حرفًا.

NotSupportedException

يحتوي الملف في path على نقطتين (:) في وسط السلسلة.

FileNotFoundException

لم يتم العثور على الملف.

DirectoryNotFoundException

المسار المحدد غير صالح، مثل أن يكون على محرك غير مخصص.

IOException

الملف مفتوح بالفعل.

InvalidDataException

الملف في path ليس أرشيف xar صالح.

الخصائص

Entries

يحصل على إدخالات من نوع Aspose.Zip.Xar.XarEntry التي تشكل الأرشيف.

public IEnumerable<xarentry> Entries { get; }

قيمة الخاصية

IEnumerable<XarEntry&gt;

الطرق

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 المضافة.

العائدات

XarArchive

مثيل إدخال Xar.

أمثلة

using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
    using (var archive = new XarArchive())
    {
        archive.CreateEntries(@"C:\folder", false);
        archive.Save(xarFile);
    }
}

الاستثناءات

ArgumentNullException

sourceDirectory هو null.

SecurityException

لا يمتلك المتصل الإذن المطلوب للوصول إلى sourceDirectory.

ArgumentException

sourceDirectory يحتوي على أحرف غير صالحة مثل “، <، >، أو |.

PathTooLongException

تجاوز path أو اسم الملف، أو كليهما، الطول الأقصى المحدد بواسطة النظام. على سبيل المثال، في الأنظمة المعتمدة على ويندوز، يجب أن تكون المسارات أقل من 248 حرفًا، ويجب أن تكون أسماء الملفات أقل من 260 حرفًا. تجاوز path أو اسم الملف، أو كليهما، الطول.

IOException

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 المضافة.

العائدات

XarArchive

مثيل إدخال 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);
    }
}

الاستثناءات

ArgumentNullException

directory هو null.

SecurityException

لا يمتلك المتصل الإذن المطلوب للوصول إلى directory.

IOException

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 المضافة.

العائدات

XarEntry

مثيل إدخال Xar.

أمثلة

FileInfo fileInfo = new FileInfo("data.bin");
using (var archive = new XarArchive())
{
    archive.CreateEntry("test.bin", fileInfo);
    archive.Save("archive.xar");
}

ملاحظات

إذا تم فتح الملف على الفور مع معلمة openImmediately، فإنه يصبح محجوزًا حتى يتم التخلص من الأرشيف.

الاستثناءات

ArgumentNullException

name هو null.

ArgumentException

name فارغ.

ArgumentNullException

fileInfo هو null.

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 المضافة.

العائدات

XarEntry

مثيل إدخال Xar.

أمثلة

using (var archive = new XarArchive())
{
    archive.CreateEntry("first.bin", "data.bin");
    archive.Save("archive.xar");
}

ملاحظات

يتم تعيين اسم الإدخال فقط ضمن معلمة name. اسم الملف المقدم في معلمة sourcePath لا يؤثر على اسم الإدخال.

إذا تم فتح الملف على الفور مع معلمة openImmediately، فإنه يصبح محجوزًا حتى يتم التخلص من الأرشيف.

الاستثناءات

ArgumentNullException

sourcePath هو null.

SecurityException

لا يمتلك المتصل الإذن المطلوب للوصول.

ArgumentException

sourcePath فارغ، يحتوي فقط على مساحات بيضاء، أو يحتوي على أحرف غير صالحة. - أو - اسم الملف، كجزء من name، يتجاوز 100 رمز.

UnauthorizedAccessException

تم رفض الوصول إلى ملف sourcePath.

PathTooLongException

تجاوز sourcePath أو اسم الملف، أو كليهما، الطول الأقصى المحدد بواسطة النظام. على سبيل المثال، في الأنظمة المعتمدة على ويندوز، يجب أن تكون المسارات أقل من 248 حرفًا، ويجب أن تكون أسماء الملفات أقل من 260 حرفًا. - أو - name طويل جدًا بالنسبة لـ xar.

NotSupportedException

يحتوي الملف في sourcePath على نقطتين (:) في وسط السلسلة.

InvalidOperationException

من المستحيل تعديل أرشيف 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 المضافة.

العائدات

XarEntry

مثيل إدخال Xar.

أمثلة

using (var archive = new XarArchive())
{
    archive.CreateEntry("data.bin", File.OpenRead("data.bin"));
    archive.Save("archive.xar");
}

الاستثناءات

ArgumentNullException

name هو null.

ArgumentNullException

source هو null.

ArgumentException

name فارغ.

InvalidOperationException

من المستحيل تعديل أرشيف xar.

DeleteEntry(XarEntry)

يُزيل أول ظهور لإدخال معين من قائمة الإدخالات.

public XarArchive DeleteEntry(XarEntry entry)

المعلمات

entry XarEntry

الإدخال الذي سيتم إزالته من قائمة الإدخالات.

العائدات

XarArchive

مثيل إدخال Xar.

أمثلة

إليك كيفية إزالة جميع الإدخالات باستثناء الأخيرة:

using (var archive = new XarArchive("archive.xar"))
{
    while (archive.Entries.Count > 1)
        archive.DeleteEntry(archive.Entries.FirstOrDefault());
    archive.Save(outputXarFile);
}

الاستثناءات

ArgumentNullException

entry هو null.

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");
}

ملاحظات

إذا لم يكن الدليل موجودًا، سيتم إنشاؤه.

الاستثناءات

ArgumentNullException

path هو null

PathTooLongException

تجاوز path أو اسم الملف، أو كليهما، الطول الأقصى المحدد بواسطة النظام. على سبيل المثال، في الأنظمة المعتمدة على ويندوز، يجب أن تكون المسارات أقل من 248 حرفًا ويجب أن تكون أسماء الملفات أقل من 260 حرفًا.

SecurityException

لا يمتلك المتصل الإذن المطلوب للوصول إلى الدليل الموجود.

NotSupportedException

إذا لم يكن الدليل موجودًا، يحتوي المسار على حرف نقطتين (:) ليس جزءًا من تسمية محرك (“C:").

ArgumentException

path هو سلسلة بطول صفر، يحتوي فقط على مسافات بيضاء، أو يحتوي على حرف واحد أو أكثر غير صالح. يمكنك الاستعلام عن الأحرف غير الصالحة باستخدام طريقة System.IO.Path.GetInvalidPathChars. - أو - path مسبوق بـ، أو يحتوي، فقط على حرف نقطتين (:).

IOException

الدليل المحدد بواسطة path هو ملف. - أو - الاسم الشبكي غير معروف.

InvalidDataException

الأرشيف تالف.

Save(string, XarSaveOptions)

يحفظ الأرشيف إلى ملف الوجهة المقدم.

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

المعلمات

destinationFileName string

مسار الأرشيف الذي سيتم إنشاؤه. إذا كان اسم الملف المحدد يشير إلى ملف موجود، فسيتم الكتابة فوقه.

saveOptions XarSaveOptions

خيارات لحفظ أرشيف xar بها.

الاستثناءات

ArgumentNullException

destinationFileName هو null.

InvalidOperationException

من المستحيل تعديل أرشيف xar.

Save(Stream, XarSaveOptions)

يحفظ الأرشيف إلى التيار المقدم.

public void Save(Stream output, XarSaveOptions saveOptions = null)

المعلمات

output Stream

تيار الوجهة.

saveOptions XarSaveOptions

خيارات لحفظ أرشيف xar بها.

الاستثناءات

ArgumentNullException

output هو null.

ArgumentException

output ليس قابلًا للكتابة/القراءة أو ليس قابلًا للبحث.

InvalidOperationException

من المستحيل تعديل أرشيف xar.