CompressionEngine Class

DTF API

Copy image CopyHover image
Deployment Tools Foundation CompressionEngine Class
Deployment Tools Foundation NamespacesMicrosoft.Deployment.CompressionCompressionEngine
Base class for an engine capable of packing and unpacking a particular compressed file format.
Declaration Syntax
C# Visual Basic Visual C++ F#
public abstract class CompressionEngine : IDisposable
Public MustInherit Class CompressionEngine
	Implements IDisposable
public ref class CompressionEngine abstract : IDisposable
[<AbstractClassAttribute>]
type CompressionEngine =  
    class
        interface IDisposable
    end
Members
All Members Constructors Methods Properties Events



Icon Member Description
CompressionEngine()()()()
Creates a new instance of the compression engine base class.

CompressionLevel
Compression level to use when compressing files.

DateTimeToDosDateAndTime(DateTime, Int16%, Int16%)
Compresion utility function for converting a DateTime structure to old-style date and time values.

Dispose()()()()
Disposes of resources allocated by the compression engine.

Dispose(Boolean)
Disposes of resources allocated by the compression engine.

DosDateAndTimeToDateTime(Int16, Int16, DateTime%)
Compresion utility function for converting old-style date and time values to a DateTime structure.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Disposes the compression engine.
(Overrides Object.Finalize()()()().)
FindArchiveOffset(Stream)
Gets the offset of an archive that is positioned 0 or more bytes from the start of the Stream.

GetFileInfo(Stream)
Gets information about all files in an archive stream.

GetFileInfo(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Gets information about files in an archive or archive chain.

GetFiles(Stream)
Gets the list of files in an archive Stream.

GetFiles(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Gets the list of files in an archive or archive chain.

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 archive.

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.

Pack(IPackStreamContext, IEnumerable<(Of <<'(String>)>>))
Creates an archive.

Pack(IPackStreamContext, IEnumerable<(Of <<'(String>)>>), Int64)
Creates an archive or chain of archives.

Progress
Occurs when the compression engine reports progress in packing or unpacking an archive.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Unpack(Stream, String)
Reads a single file from an archive stream.

Unpack(IUnpackStreamContext, Predicate<(Of <<'(String>)>>))
Extracts files from an archive or archive chain.

UseTempFiles
Gets or sets a flag indicating whether temporary files are created and used during compression.

Inheritance Hierarchy
Object
CompressionEngine
  CabEngine
  ZipEngine

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