Class XarLoadOptions
Class XarLoadOptions
Namespace: Aspose.Zip.Xar
Assembly: Aspose.Zip.dll (25.7.0)
Options with which XAR archive is loaded from a compressed file.
public class XarLoadOptions
Inheritance
Inherited Members
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Constructors
XarLoadOptions()
public XarLoadOptions()
Properties
CancellationToken
Gets or sets a cancellation token used to cancel the extraction operation.
public CancellationToken CancellationToken { get; set; }
Property Value
Examples
Cancel XAR archive extraction after a certain time.
using (CancellationTokenSource cts = new CancellationTokenSource())
{
cts.CancelAfter(TimeSpan.FromSeconds(60));
using (var a = new XarArchive("big.xar", new XarLoadOptions() { CancellationToken = cts.Token }))
{
try
{
(XarFileEntry)(a.Entries.First()).Extract("data.bin");
}
catch(OperationCanceledException)
{
Console.WriteLine("Extraction was cancelled after 60 seconds");
}
}
}
```<p>
Using with <code>Task</code>
```csharp
CancellationTokenSource cts = new CancellationTokenSource();
cts.CancelAfter(TimeSpan.FromSeconds(60));
Task t = Task.Run(delegate()
{
var loadOptions = new XarLoadOptions() { CancellationToken = cts.Token };
using (var a = new XarArchive("big.xar", loadOptions))
{
a.ExtractToDirectory("destination");
}
}, cts.Token);
t.ContinueWith(delegate(Task antecedent)
{
if (antecedent.IsCanceled)
{
Console.WriteLine("Extraction was cancelled after 60 seconds");
}
cts.Dispose();
});
```</p>
Cancellation mostly results in some data not being extracted.
#### Remarks
This property exists for .NET Framework 4.0 and above.
### <a id="Aspose_Zip_Xar_XarLoadOptions_EntryExtractionProgressed"></a> EntryExtractionProgressed
Gets or sets the delegate invoked when some bytes have been extracted.
```csharp
public EventHandler<progresseventargs> EntryExtractionProgressed { get; set; }
Property Value
EventHandler < ProgressEventArgs >
Examples
XarArchive archive = new XarArchive("archive.xar",
new XarLoadOptions() { EntryExtractionProgressed = (s, e) => { int percent = (int)((100 * e.ProceededBytes) / ((XarFileEntry)s).Length); } })
Remarks
Event sender is the Aspose.Zip.Xar.XarFileEntry instance which extraction is progressed.