Public Types | Public Attributes | List of all members
CZipSegmCallback Struct Reference

#include <ZipCallback.h>

Inheritance diagram for CZipSegmCallback:
Inheritance graph

Public Types

enum  SegmCodes {
  scVolumeNeededForRead, scVolumeNeededForWrite, scFileNameDuplicated, scCannotSetVolLabel,
  scFileCreationFailure, scFileNotFound
}
 

Public Attributes

int m_iCode
 The reason for calling the callback. It can be one of the SegmCodes values.
 
ZIP_VOLUME_TYPE m_uVolumeNeeded
 The number of the volume needed when reading or writing a segmented archive. Volumes are numbered starting from 1.
 
- Public Attributes inherited from CZipCallback
CZipString m_szExternalFile
 

Additional Inherited Members

- Public Member Functions inherited from CZipCallback
virtual bool Callback (ZIP_SIZE_TYPE uProgress)=0
 

Detailed Description

When you derive from CZipSegmCallback, you can use the derived class as a callback object for:

You need to override the CZipActionCallback::Callback method. The value of the uProgress parameter in the callback method has the following meaning:

Return false from the callback function to abort the operation: the proper exception will be thrown.

See Also
Segmented Archives: Splitting and Spanning
CZipActionCallback::Callback
CZipArchive::SetSegmCallback

Definition at line 120 of file ZipCallback.h.

Member Enumeration Documentation

Values indicating the reason for calling the callback.

Enumerator:
scVolumeNeededForRead 

The next volume is needed when reading a segmented archive. The number of the volume is stored in m_uVolumeNeeded.

scVolumeNeededForWrite 

The next volume is needed when writing a segmented archive. The number of the volume is stored in m_uVolumeNeeded.

scFileNameDuplicated 

The file that is used for writing a new volume already exists.

scCannotSetVolLabel 

The disk label could not be set. The disk may be write-protected. It is called only for spanned archives.

scFileCreationFailure 

The archive file could not be created. The disk may be write-protected.

scFileNotFound 

The given volume file was not found when reading a split archive. The number of the volume is stored in m_uVolumeNeeded. It is called only for split archives.

Definition at line 125 of file ZipCallback.h.

Member Data Documentation

int CZipSegmCallback::m_iCode

The reason for calling the callback. It can be one of the SegmCodes values.

Definition at line 137 of file ZipCallback.h.

ZIP_VOLUME_TYPE CZipSegmCallback::m_uVolumeNeeded

The number of the volume needed when reading or writing a segmented archive. Volumes are numbered starting from 1.

Definition at line 135 of file ZipCallback.h.


The documentation for this struct was generated from the following file:

The ZipArchive Library Copyright © 2000 - 2022 Artpol Software - Tadeusz Dracz. Generated at Sat Dec 17 2022 19:57:04.