CabEngine Class

DTF API

Copy image CopyHover image
Deployment Tools Foundation CabEngine Class
Deployment Tools Foundation NamespacesMicrosoft.Deployment.Compression.CabCabEngine
Engine capable of packing and unpacking archives in the cabinet format.
Declaration Syntax
C# Visual Basic Visual C++ F#
public class CabEngine : CompressionEngine
Public Class CabEngine
	Inherits CompressionEngine
public ref class CabEngine : public CompressionEngine
type CabEngine =  
    class
        inherit CompressionEngine
    end
Members
All Members Constructors Methods Properties Events



Icon Member Description
CabEngine()()()()
Creates a new instance of the cabinet engine.

CompressionLevel
Compression level to use when compressing files.
(Inherited from CompressionEngine.)
Dispose(Boolean)
Disposes of resources allocated by the cabinet engine.
(Overrides CompressionEngine.Dispose(Boolean).)
Dispose()()()()
Disposes of resources allocated by the compression engine.
(Inherited from CompressionEngine.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Disposes the compression engine.
(Inherited from CompressionEngine.)
FindArchiveOffset(Stream)
Gets the offset of an archive that is positioned 0 or more bytes from the start of the Stream.
(Inherited from CompressionEngine.)
GetFileInfo(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Gets information about files in a cabinet or cabinet chain.
(Overrides CompressionEngine.GetFileInfo(IUnpackStreamContext, Predicate<(Of <<'(String>)>>)).)
GetFileInfo(Stream)
Gets information about all files in an archive stream.
(Inherited from CompressionEngine.)
GetFiles(Stream)
Gets the list of files in an archive Stream.
(Inherited from CompressionEngine.)
GetFiles(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Gets the list of files in an archive or archive chain.
(Inherited from CompressionEngine.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsArchive(Stream)
Checks whether a Stream begins with a header that indicates it is a valid cabinet file.
(Overrides CompressionEngine.IsArchive(Stream).)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnProgress(ArchiveProgressEventArgs)
Called by sublcasses to distribute a packing or unpacking progress event to listeners.
(Inherited from CompressionEngine.)
Pack(IPackStreamContext, IEnumerable<(Of <<'(String>)>>), Int64)
Creates a cabinet or chain of cabinets.
(Overrides CompressionEngine.Pack(IPackStreamContext, IEnumerable<(Of <<'(String>)>>), Int64).)
Pack(IPackStreamContext, IEnumerable<(Of <<'(String>)>>))
Creates an archive.
(Inherited from CompressionEngine.)
Progress
Occurs when the compression engine reports progress in packing or unpacking an archive.
(Inherited from CompressionEngine.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Unpack(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Extracts files from a cabinet or cabinet chain.
(Overrides CompressionEngine.Unpack(IUnpackStreamContext, Predicate<(Of <<'(String>)>>)).)
Unpack(Stream, String)
Reads a single file from an archive stream.
(Inherited from CompressionEngine.)
UseTempFiles
Gets or sets a flag indicating whether temporary files are created and used during compression.
(Inherited from CompressionEngine.)
Inheritance Hierarchy
Object
CompressionEngine
  CabEngine

Assembly: Microsoft.Deployment.Compression.Cab (Module: Microsoft.Deployment.Compression.Cab.dll) Version: 3.0.0.0 (3.11.1.2318)