Class XarArchive

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, שם הקובץ, או שניהם חורגים מהאורך המרבי המוגדר על ידי המערכת. לדוגמה, בפלטפורמות מבוססות Windows, הנתיבים חייבים להיות פחות מ-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

הנתיב, שם הקובץ, או שניהם חורגים מהאורך המרבי המוגדר על ידי המערכת. לדוגמה, בפלטפורמות מבוססות Windows, הנתיבים חייבים להיות פחות מ-248 תווים, ושמות הקבצים חייבים להיות פחות מ-260 תווים. הנתיב, שם הקובץ, או שניהם ארוכים מדי.

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, שם הקובץ, או שניהם חורגים מהאורך המרבי המוגדר על ידי המערכת. לדוגמה, בפלטפורמות מבוססות Windows, הנתיבים חייבים להיות פחות מ-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 &gt; 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

הנתיב, שם הקובץ, או שניהם חורגים מהאורך המרבי המוגדר על ידי המערכת. לדוגמה, בפלטפורמות מבוססות Windows, הנתיבים חייבים להיות פחות מ-248 תווים ושמות הקבצים חייבים להיות פחות מ-260 תווים.

SecurityException

לקרוא לא יש את ההרשאה הנדרשת לגישה לתיקיה הקיימת.

NotSupportedException

אם התיקיה אינה קיימת, הנתיב מכיל תו נקודתיים (:) שאינו חלק מתווית הכונן (“C:").

ArgumentException

path הוא מחרוזת באורך אפס, מכיל רק רווחים, או מכיל תו אחד או יותר לא חוקיים. אתה יכול לבדוק תווים לא חוקיים על ידי שימוש בשיטה System.IO.Path.GetInvalidPathChars. -או- path מקדים, או מכיל, רק תו נקודתיים (:).

IOException

התיקיה המצוינת בנתיב היא קובץ. -או- שם הרשת אינו ידוע.

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.

 Ελληνικά