The PATCH_STATUS_INFORMATION structure contains information about the status of the current patch creation or application process. A pointer to this structure is passed to the user-defined OnStatus virtual method.

typedef struct _PATCH_STATUS_INFORMATION
{
    DWORD   dwStatusId;              // status of current operation 
    DWORD   dwReserved;              // reserved value 
    DWORD   dwFilesToProcess;        // number of files to process 
    DWORD   dwFilesProcessed;        // number of files processed 
    DWORD   dwTotalProgress;         // total progress (percentage) 
    DWORD   dwTotalBytesToProcess;   // total number of bytes to process 
    DWORD   dwTotalBytesProcessed;   // total number of bytes processed 
    DWORD   dwFileProgress;          // file progress (percentage) 
    DWORD   dwFileBytesToProcess;    // length of file being processed 
    DWORD   dwFileBytesProcessed;    // number of bytes processed in file 
    CHAR    szFileName[MAX_PATH];    // file name 
} PATCH_STATUS_INFORMATION;

Members

dwStatusId

Specifies the current status of the patch operation.

 

This member may be set to one of the following values:

Value	Description
PATCH_STATUS_CREATE	The first callback made when a patch or package file is created. The file name is the name of the patch or package file.
PATCH_STATUS_OPEN	This callback is made when the patch apply process begins or a package is opened. The name of the file is the patch or package file.
PATCH_STATUS_CLOSE	This callback is made when the patch or package creation process has completed and the file is being closed. The file name is the name of the patch or package file.
PATCH_STATUS_SEARCH	This callback is made when a file could not be found in the specified directory. The file name is set to the name of the file that is being searched for.
PATCH_STATUS_FOUND	This callback is made when the file being searched for has been found. The file name is the name of the found file.
PATCH_STATUS_ANALYZE	This callback is made during the process of analyzing the old and new files to determine what changes must be made when updating the file. The file name is set to the name of the new file.
PATCH_STATUS_MODIFY	This callback is made when a file is being updated on the local system. The file name is the name of the file being modified.
PATCH_STATUS_COMPRESS	This callback is made during the process of compressing data. The file name is set to the name of the file that is being compressed.
PATCH_STATUS_EXPAND	This callback is made during the process of expanding compressed data. The file name is set to the name of the file that is being expanded.
PATCH_STATUS_REPLACE	This callback is made before a local file is replaced. The file name is set to the name of the file that will be replaced if the operation continues.
PATCH_STATUS_REMOVE	This callback is made before a local file is removed. The file name is set to the name of the file that will be deleted if the operation continues.
PATCH_STATUS_STORE	This callback is made before a file is stored on the local system. The file name is set to the name of the file being stored.
PATCH_STATUS_EXTRACT	This callback is made before a file is extracted from a package. The file name is set to the name of the file in the package that is being extracted.
PATCH_STATUS_APPLY	This callback is made before an update is applied on the local system. The file name is set to the name of the file in the package that is being applied.
PATCH_STATUS_REGISTER	This callback is made before a component is registered on the local system. The file name is set to the name of the component being registered.

dwReserved

Specifies the length of the file at the time the patch was created. Note that this is not the length of the patch file itself.

 

dwFilesToProcess

Specifies the total number of files that will be processed during this operation.

 

dwFilesProcessed

Specifies the number of files that have been processed.

 

dwTotalProgress

Specifies the total progress of the current operation, expressed as a percentage value between 0 and 100.

 

dwTotalBytesToProcess

Specifies the total number of bytes in all of the files that will be processed during this operation.

 

dwTotalBytesProcessed

Specifies the total number of bytes in all of the files that have been processed.

 

dwFileBytesToProcess

Specifies the total number of bytes in the current file that will be processed during this operation.

 

dwFileBytesProcessed

Specifies the number of bytes in the current file that have been processed.

 

szFileName

Specifies the name of the file that is currently being processed. Depending on the status ID, this may refer to the name of the file in the current package or a file on the local system.

Requirements

Windows NT/2000/XP: Requires Windows NT 4.0 SP3 or later.
Windows 95/98: Requires Windows 95 or later.
Header: Declared in apatch.h.

See Also

CPatchFile::Apply, CPackage::Apply, CPackage::Create, CPatchFile::Create, CPackage::Update