ArchiveProgressEventArgs Class

DTF API

Copy image CopyHover image
Deployment Tools Foundation ArchiveProgressEventArgs Class
Deployment Tools Foundation NamespacesMicrosoft.Deployment.CompressionArchiveProgressEventArgs
Contains the data reported in an archive progress event.
Declaration Syntax
C# Visual Basic Visual C++ F#
public class ArchiveProgressEventArgs : EventArgs
Public Class ArchiveProgressEventArgs
	Inherits EventArgs
public ref class ArchiveProgressEventArgs : public EventArgs
type ArchiveProgressEventArgs =  
    class
        inherit EventArgs
    end
Members
All Members Constructors Methods Properties



Icon Member Description
ArchiveProgressEventArgs(ArchiveProgressType, String, Int32, Int32, Int64, Int64, String, Int32, Int32, Int64, Int64, Int64, Int64)
Creates a new ArchiveProgressEventArgs object from specified event parameters.

CurrentArchiveBytesProcessed
Gets the number of compressed bytes processed so far during extraction of the current archive. Valid for all extraction messages.

CurrentArchiveName
Gets the name of the current archive. Not necessarily the name of the archive on disk. Valid for all message types.

CurrentArchiveNumber
Gets the current archive number, when processing a chained set of archives. Valid for all message types.

CurrentArchiveTotalBytes
Gets the total number of compressed bytes to be processed during extraction of the current archive. Valid for all extraction messages.

CurrentFileBytesProcessed
Gets the number of bytes processed so far when compressing or extracting a file. Valid for StartFile, PartialFile, and FinishFile messages.

CurrentFileName
Gets the name of the file being processed. (The name of the file within the Archive; not the external file path.) Also includes the internal path of the file, if any. Valid for StartFile, PartialFile, and FinishFile messages.

CurrentFileNumber
Gets the number of the current file being processed. The first file is number 0, and the last file is TotalFiles-1. Valid for StartFile, PartialFile, and FinishFile messages.

CurrentFileTotalBytes
Gets the total number of bytes in the current file. Valid for StartFile, PartialFile, and FinishFile messages.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FileBytesProcessed
Gets the number of uncompressed bytes processed so far among all files. Valid for all message types.

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ProgressType
Gets the type of status message.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
TotalArchives
Gets the total number of known archives in a chained set. Valid for all message types.

TotalFileBytes
Gets the total number of uncompressed file bytes to be processed. Valid for all message types.

TotalFiles
Gets the total number of files to be processed. Valid for all message types.

Inheritance Hierarchy
Object
EventArgs
  ArchiveProgressEventArgs

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