Class GzipLoadOptions
Class GzipLoadOptions
Namespace: Aspose.Zip.Gzip
Assembly: Aspose.Zip.dll (25.7.0)
Options for loading Aspose.Zip.Gzip.GzipArchive.
public class GzipLoadOptions
Inheritance
Inherited Members
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Remarks
In the .NET Framework 4.0 and above, can be used to cancel extraction.
Constructors
GzipLoadOptions()
public GzipLoadOptions()
Properties
CancellationToken
Gets or sets a cancellation token used to cancel the extraction operation.
public CancellationToken CancellationToken { get; set; }
Property Value
Examples
Cancel gzip archive extraction after a certain time.
using (CancellationTokenSource cts = new CancellationTokenSource())
{
cts.CancelAfter(TimeSpan.FromSeconds(60));
using (var a = new GzipArchive("big.gz", new GzipLoadOptions() { CancellationToken = cts.Token }))
{
try
{
a.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 GzipLoadOptions() { CancellationToken = cts.Token };
using (var a = GzipArchive("big.gz", 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_Gzip_GzipLoadOptions_ParseHeader"></a> ParseHeader
Gets or sets the value indicating whether to parse stream header to figure out properties, including name. Makes sense for seekable stream only.
```csharp
public bool ParseHeader { get; set; }