Class WimArchive
Namespace: Aspose.Zip.Wim
Assembly: Aspose.Zip.dll (25.8.0)
This class represents a wim archive file.
public class WimArchive : IArchive, IDisposableInheritance
Implements
Inherited Members
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Constructors
WimArchive(Stream, WimLoadOptions)
Initializes a new instance of the Aspose.Zip.Wim.WimArchive class and composes an entry list can be extracted from the archive.
public WimArchive(Stream sourceStream, WimLoadOptions loadOptions = null)Parameters
sourceStream Stream
The source of the archive. It must be seekable.
loadOptions WimLoadOptions
Options to load existing archive with.
Examples
The following example shows how to extract all the entries to a directory.
using (var archive = new WimArchive(File.OpenRead("archive.wim")))
{
archive.Images[0].ExtractToDirectory("C:\\extracted");
}Remarks
This constructor does not unpack any entry. See Aspose.Zip.Wim.WimFileEntry.Open method for unpacking.
Exceptions
sourceStream is null.
sourceStream is not seekable.
sourceStream is not valid wim archive.
WimArchive(string, WimLoadOptions)
Initializes a new instance of the Aspose.Zip.Wim.WimArchive class and composes an entry list can be extracted from the archive.
public WimArchive(string path, WimLoadOptions loadOptions = null)Parameters
path string
The path to the archive file.
loadOptions WimLoadOptions
Options to load existing archive with.
Examples
The following example shows how to extract all the entries to a directory.
using (var archive = new WimArchive("archive.wim"))
{
archive.Images[0].ExtractToDirectory("C:\\extracted");
}Remarks
This constructor does not unpack any entry. See Aspose.Zip.Wim.WimFileEntry.Open method for unpacking.
Exceptions
path is null.
The caller does not have the required permission to access.
The path is empty, contains only white spaces, or contains invalid characters.
Access to file path is denied.
The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
File at path contains a colon (:) in the middle of the string.
The file is not found.
The specified path is invalid, such as being on an unmapped drive.
The file is already open.
Properties
BootImageIndex
Gets the (zero-based) index of the bootable image.
public int BootImageIndex { get; }Property Value
Exceptions
Archive has been disposed and cannot be used.
FileFormatVersion
Gets the version of the file format.
public int FileFormatVersion { get; }Property Value
Exceptions
Archive has been disposed and cannot be used.
Guid
Gets the identifying GUID for the archive.
public Guid Guid { get; }Property Value
Exceptions
Archive has been disposed and cannot be used.
Images
Gets entries of Aspose.Zip.Wim.WimImage type constituting the archive.
public ReadOnlyCollection<wimimage> Images { get; }Property Value
ReadOnlyCollection < WimImage >
Exceptions
Archive has been disposed and cannot be used.
Manifest
Gets the embedded manifest describing the file and the contained images.
public string Manifest { get; }Property Value
Exceptions
Archive has been disposed and cannot be used.
Methods
Dispose(bool)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected virtual void Dispose(bool disposing)Parameters
disposing bool
Whether managed resources should be disposed.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()ExtractToDirectory(string)
Extracts the archive to the file by path.
public void ExtractToDirectory(string destinationDirectory)Parameters
destinationDirectory string
The path to the directory to place the extracted files in.
Exceptions
Archive has been disposed and cannot be used.
destinationDirectory is null
The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters and file names must be less than 260 characters.
The caller does not have the required permission to access the existing directory.
If the directory does not exist, the path contains a colon character (:) that is not part of a drive label (“C:") - or - WIM archive is multi-part.
path is a zero-length string, contains only white space, or contains one or more invalid characters. You can query for invalid characters by using the System.IO.Path.GetInvalidPathChars method. -or- path is prefixed with, or contains, only a colon character (:).
The directory specified by path is a file. -or- The network name is not known.
The archive is corrupted.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
