ArchiveWriter Class

Properties Methods Events Configuration Settings Errors

The ArchiveWriter class allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


ArchiveType	The type of the archive.
CompressionAlgorithm	TBD.
CompressionLevel	The compression level to apply to the archived data.
DecryptionCertCount	The number of records in the DecryptionCert arrays.
DecryptionCertBytes	Returns raw certificate data in DER format.
DecryptionCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
DecryptionPassword	The decryption password.
EncryptionAlgorithm	Specifies the encryption algorithm to apply to the archive.
EncryptionCertBytes	Returns raw certificate data in DER format.
EncryptionCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptionKeyLength	The length of the encryption key.
EncryptionPassword	Specifies the archive encryption password.
EncryptionType	The type of encryption to apply to the archive.
FileData	The contents of the file being added to the archive.
FileCount	The number of records in the File arrays.
FileAction	The action to apply to the file.
FileCompressedSize	The size of the file after compression.
FileDataSource	The type of the data source for this entry.
FileDirectory	Tells if the entry is a directory or a regular file.
FileEncryptionAlgorithm	Returns the symmetric algorithm that was used to encrypt the file.
FileEncryptionKeyLength	Returns the length, in bits, of the encryption key.
FileEncryptionType	The type of encryption applied to the file.
FileFileName	The original name of the compressed file or folder.
FileFolder	The containing folder of the entry.
FileLocalPath	The local path associated with this entry.
FileMTime	The entry's last modification time.
FileNewFile	Indicates whether the entry corresponds to a file to be added to the archive.
FilePath	The full internal path of the archived entry.
FileSignatureCount	The number of signatures covering the entry.
FileSigned	Indicates whether the entry is signed.
FileSize	The size of the file before compression.
FIPSMode	Reserved.
NewArchive	Indicates whether the archive object represents a new (rather than opened) archive.
Opened	Indicates whether class is currently in edit mode.
SigningCertBytes	Returns raw certificate data in DER format.
SigningCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SigningChainCount	The number of records in the SigningChain arrays.
SigningChainBytes	Returns raw certificate data in DER format.
SigningChainHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AddEmptyDir	Adds an empty folder to the archive.
AddFile	Adds a file to the archive.
AddFiles	Adds a group of files to the archive.
AddVirtual	Adds a file placeholder to the archive.
Close	Closes the archive.
Config	Sets or retrieves a configuration setting.
CreateNew	Creates a new archive.
DoAction	Performs an additional action.
Open	Opens an archive file.
OpenBytes	Loads an archive file from a byte array.
Remove	Removes file(s) and/or folder(s) from the archive.
Save	Compresses the archive and saves it to a file.
SaveBytes	Compresses the archive and saves it to a byte array.
UpdateFile	Updates an existing compressed entry with a fresher local version.
UpdateFiles	Updates a selection of files in the archive.
UpdateVirtual	Updates an entry in the archive with on-the-fly content.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


AfterCompressFile	Marks the completion of compression of a file.
BeforeCompressFile	Marks the start of compression of a file.
DecryptionPasswordNeeded	Fires when the class needs a password to decrypt the archive.
Error	Reports information about errors during archive assembling.
Notification	This event notifies the application about an underlying control flow event.
PrepareFile	Fires for every file to be compressed before the compression starts.
Progress	Reports the progress of data compression.
RecipientFound	Signifies that the archive was found to be encrypted with a digital certificate.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


TempPath	Path for storing temporary files.
UsePax	Enables use of PAX algorithm when creating TAR directories.
UseUStar	Enables use of UStar variant of file name packaging when creating TAR directories.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

ArchiveType Property (ArchiveWriter Class)

The type of the archive.

Syntax

int GetArchiveType();

Possible Values

AFT_UNKNOWN(0), 
AFT_ZIP(1), 
AFT_GZIP(2), 
AFT_BZIP_2(3), 
AFT_TAR(4), 
AFT_TAR_GZIP(5), 
AFT_TAR_BZIP_2(6), 
AFT_SFX(7)

Default Value

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

Integer

CompressionAlgorithm Property (ArchiveWriter Class)

TBD.

Syntax

int GetCompressionAlgorithm();
int SetCompressionAlgorithm(int iCompressionAlgorithm);

Default Value

Remarks

TBD.

Data Type

Integer

CompressionLevel Property (ArchiveWriter Class)

The compression level to apply to the archived data.

Syntax

int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Default Value

Remarks

Use this property to specify the compression level to apply to the archived data.

Data Type

Integer

DecryptionCertCount Property (ArchiveWriter Class)

The number of records in the DecryptionCert arrays.

Syntax

int GetDecryptionCertCount();
int SetDecryptionCertCount(int iDecryptionCertCount);

Default Value

Remarks

This property controls the size of the following arrays:

DecryptionCertBytes
DecryptionCertHandle

The array indices start at 0 and end at DecryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptionCertBytes Property (ArchiveWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetDecryptionCertBytes(int iDecryptionCertIndex);

Remarks

Returns raw certificate data in DER format.

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetDecryptionCertHandle(int iDecryptionCertIndex);
int SetDecryptionCertHandle(int iDecryptionCertIndex, qint64 lDecryptionCertHandle);

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is not available at design time.

Data Type

Long64

DecryptionPassword Property (ArchiveWriter Class)

The decryption password.

Syntax

QString GetDecryptionPassword();
int SetDecryptionPassword(QString qsDecryptionPassword);

Default Value

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

Data Type

String

EncryptionAlgorithm Property (ArchiveWriter Class)

Specifies the encryption algorithm to apply to the archive.

Syntax

QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);

Default Value

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Class supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

Data Type

String

EncryptionCertBytes Property (ArchiveWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetEncryptionCertBytes();

Remarks

Returns raw certificate data in DER format.

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertHandle Property (ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetEncryptionCertHandle();
int SetEncryptionCertHandle(qint64 lEncryptionCertHandle);

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is not available at design time.

Data Type

Long64

EncryptionKeyLength Property (ArchiveWriter Class)

The length of the encryption key.

Syntax

int GetEncryptionKeyLength();
int SetEncryptionKeyLength(int iEncryptionKeyLength);

Default Value

Remarks

Use this setting to specify the length of the encryption key in bits.

Data Type

Integer

EncryptionPassword Property (ArchiveWriter Class)

Specifies the archive encryption password.

Syntax

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

Data Type

String

EncryptionType Property (ArchiveWriter Class)

The type of encryption to apply to the archive.

Syntax

int GetEncryptionType();
int SetEncryptionType(int iEncryptionType);

Possible Values

AET_DEFAULT(0), 
AET_NO_ENCRYPTION(1), 
AET_GENERIC(2), 
AET_WIN_ZIP(3), 
AET_STRONG(4)

Default Value

Remarks

Specifies the encryption type for the archive.

Data Type

Integer

FileData Property (ArchiveWriter Class)

The contents of the file being added to the archive.

Syntax

QByteArray GetFileData();
int SetFileData(QByteArray qbaFileData);

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

This property is not available at design time.

Data Type

Byte Array

FileCount Property (ArchiveWriter Class)

The number of records in the File arrays.

Syntax

int GetFileCount();
int SetFileCount(int iFileCount);

Default Value

Remarks

This property controls the size of the following arrays:

FileAction
FileCompressedSize
FileDataSource
FileDirectory
FileEncryptionAlgorithm
FileEncryptionKeyLength
FileEncryptionType
FileFileName
FileFolder
FileLocalPath
FileMTime
FileNewFile
FilePath
FileSignatureCount
FileSigned
FileSize

The array indices start at 0 and end at FileCount - 1.

This property is not available at design time.

Data Type

Integer

FileAction Property (ArchiveWriter Class)

The action to apply to the file.

Syntax

int GetFileAction(int iFileIndex);
int SetFileAction(int iFileIndex, int iFileAction);

Possible Values

AT_ADD(0), 
AT_KEEP(1), 
AT_UPDATE(2), 
AT_DELETE(3), 
AT_EXTRACT(4), 
AT_SKIP(5)

Default Value

Remarks

The action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:


atAdd (0)	Add the file to the archive
atKeep (1)	Keep the existing file in the archive
atUpdate (2)	Update the archived file with a fresher copy
atDelete (3)	Delete the file from the archive
atExtract (4)	Extract the file (extraction only)
atSkip (5)	Skip file extraction (extraction only)

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileCompressedSize Property (ArchiveWriter Class)

The size of the file after compression.

Syntax

qint64 GetFileCompressedSize(int iFileIndex);

Default Value

Remarks

The size of the file after compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FileDataSource Property (ArchiveWriter Class)

The type of the data source for this entry.

Syntax

int GetFileDataSource(int iFileIndex);
int SetFileDataSource(int iFileIndex, int iFileDataSource);

Possible Values

FDS_FILE(0), 
FDS_STREAM(1), 
FDS_BUFFER(2)

Default Value

Remarks

The type of the data source for this entry.

Use this property to control the data source for this entry.


fdsFile (0)	The data for this entry should be taken from the file provided via FileLocalPath.
fdsStream (1)	The data is going to be provided on-the-fly via the FileStream property.
fdsBuffer (2)	The data is going to be provided on-the-fly via the FileData property.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileDirectory Property (ArchiveWriter Class)

Tells if the entry is a directory or a regular file.

Syntax

bool GetFileDirectory(int iFileIndex);

Default Value

false

Remarks

Tells if the entry is a directory or a regular file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileEncryptionAlgorithm Property (ArchiveWriter Class)

Returns the symmetric algorithm that was used to encrypt the file.

Syntax

QString GetFileEncryptionAlgorithm(int iFileIndex);

Default Value

Remarks

Returns the symmetric algorithm that was used to encrypt the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileEncryptionKeyLength Property (ArchiveWriter Class)

Returns the length, in bits, of the encryption key.

Syntax

int GetFileEncryptionKeyLength(int iFileIndex);

Default Value

Remarks

Returns the length, in bits, of the encryption key.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileEncryptionType Property (ArchiveWriter Class)

The type of encryption applied to the file.

Syntax

int GetFileEncryptionType(int iFileIndex);

Possible Values

AET_DEFAULT(0), 
AET_NO_ENCRYPTION(1), 
AET_GENERIC(2), 
AET_WIN_ZIP(3), 
AET_STRONG(4)

Default Value

Remarks

The type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.


aetDefault (0)	Default encryption (not used for already encrypted files)
aetNoEncryption (1)	No encryption
aetGeneric (2)	Standard ZIP encryption
aetWinZip (3)	WinZIP-based encryption
aetStrong (4)	Strong encryption

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileFileName Property (ArchiveWriter Class)

The original name of the compressed file or folder.

Syntax

QString GetFileFileName(int iFileIndex);
int SetFileFileName(int iFileIndex, QString qsFileFileName);

Default Value

Remarks

The original name of the compressed file or folder.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileFolder Property (ArchiveWriter Class)

The containing folder of the entry.

Syntax

QString GetFileFolder(int iFileIndex);

Default Value

Remarks

The containing folder of the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileLocalPath Property (ArchiveWriter Class)

The local path associated with this entry.

Syntax

QString GetFileLocalPath(int iFileIndex);
int SetFileLocalPath(int iFileIndex, QString qsFileLocalPath);

Default Value

Remarks

The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileMTime Property (ArchiveWriter Class)

The entry's last modification time.

Syntax

QString GetFileMTime(int iFileIndex);
int SetFileMTime(int iFileIndex, QString qsFileMTime);

Default Value

Remarks

The entry's last modification time.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileNewFile Property (ArchiveWriter Class)

Indicates whether the entry corresponds to a file to be added to the archive.

Syntax

bool GetFileNewFile(int iFileIndex);

Default Value

false

Remarks

Indicates whether the entry corresponds to a file to be added to the archive.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FilePath Property (ArchiveWriter Class)

The full internal path of the archived entry.

Syntax

QString GetFilePath(int iFileIndex);

Default Value

Remarks

The full internal path of the archived entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileSignatureCount Property (ArchiveWriter Class)

The number of signatures covering the entry.

Syntax

int GetFileSignatureCount(int iFileIndex);

Default Value

Remarks

The number of signatures covering the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileSigned Property (ArchiveWriter Class)

Indicates whether the entry is signed.

Syntax

bool GetFileSigned(int iFileIndex);

Default Value

false

Remarks

Indicates whether the entry is signed.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileSize Property (ArchiveWriter Class)

The size of the file before compression.

Syntax

qint64 GetFileSize(int iFileIndex);

Default Value

Remarks

The size of the file before compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FIPSMode Property (ArchiveWriter Class)

Reserved.

Syntax

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

NewArchive Property (ArchiveWriter Class)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

bool GetNewArchive();

Default Value

false

Remarks

This property is set to true if the archive is new, or to false if the class control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Data Type

Boolean

Opened Property (ArchiveWriter Class)

Indicates whether class is currently in edit mode.

Syntax

bool GetOpened();

Default Value

false

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Data Type

Boolean

SigningCertBytes Property (ArchiveWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetSigningCertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (ArchiveWriter Class)

The number of records in the SigningChain arrays.

Syntax

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

Default Value

Remarks

This property controls the size of the following arrays:

SigningChainBytes
SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (ArchiveWriter Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetSigningChainBytes(int iSigningChainIndex);

Remarks

Returns raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

AddEmptyDir Method (ArchiveWriter Class)

Adds an empty folder to the archive.

Syntax

int AddEmptyDir(const QString& qsPath);

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

Error Handling

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddFile Method (ArchiveWriter Class)

Adds a file to the archive.

Syntax

int AddFile(const QString& qsPath, const QString& qsLocalPath);

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

Error Handling

AddFiles Method (ArchiveWriter Class)

Adds a group of files to the archive.

Syntax

int AddFiles(const QString& qsFolder, const QString& qsLocalPath, bool bRecursive);

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddVirtual Method (ArchiveWriter Class)

Adds a file placeholder to the archive.

Syntax

int AddVirtual(const QString& qsPath);

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Error Handling

Close Method (ArchiveWriter Class)

Closes the archive.

Syntax

int Close();

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Error Handling

Config Method (ArchiveWriter Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateNew Method (ArchiveWriter Class)

Creates a new archive.

Syntax

int CreateNew(int iArchiveType);

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:


aftZip (1)	The archive contains data in ZIP format.
aftGzip (2)	The archive file contains data in GZIP format.
aftBzip2 (3)	The archive contains BZIP2 data.
aftTar (4)	The archive contains a .tar file.
aftTarGzip (5)	The archive contains a .tar.gz file.
aftTarBzip2 (6)	The archive contains data in .tar.bz2 format.

The archive will be kept in memory until written down with Save or SaveStream method.

Error Handling

DoAction Method (ArchiveWriter Class)

Performs an additional action.

Syntax

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling

Open Method (ArchiveWriter Class)

Opens an archive file.

Syntax

int Open(int iArchiveType, const QString& qsArchiveName);

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:


aftUnknown (0)	It was not possible to establish the type of the archive file.
aftZip (1)	The archive contains data in ZIP format.
aftGzip (2)	The archive file contains data in GZIP format.
aftBzip2 (3)	The archive contains BZIP2 data.
aftTar (4)	The archive contains a .tar file.
aftTarGzip (5)	The archive contains a .tar.gz file.
aftTarBzip2 (6)	The archive contains data in .tar.bz2 format.

The archive will be kept in memory until written down with Save or SaveStream method.

Error Handling

OpenBytes Method (ArchiveWriter Class)

Loads an archive file from a byte array.

Syntax

int OpenBytes(int iArchiveType, QByteArray qbaArchiveBytes);

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:


aftUnknown (0)	It was not possible to establish the type of the archive.
aftZip (1)	The archive contains data in ZIP format.
aftGzip (2)	The archive file contains data in GZIP format.
aftBzip2 (3)	The archive contains BZIP2 data.
aftTar (4)	The archive contains a .tar file.
aftTarGzip (5)	The archive contains a .tar.gz file.
aftTarBzip2 (6)	The archive contains data in .tar.bz2 format.

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

Error Handling

Remove Method (ArchiveWriter Class)

Removes file(s) and/or folder(s) from the archive.

Syntax

int Remove(const QString& qsPath);

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Error Handling

Save Method (ArchiveWriter Class)

Compresses the archive and saves it to a file.

Syntax

int Save(const QString& qsArchiveName);

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

Error Handling

SaveBytes Method (ArchiveWriter Class)

Compresses the archive and saves it to a byte array.

Syntax

QByteArray SaveBytes();

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the Save method for the details.

Error Handling

This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

UpdateFile Method (ArchiveWriter Class)

Updates an existing compressed entry with a fresher local version.

Syntax

int UpdateFile(const QString& qsPath, const QString& qsLocalPath);

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

Error Handling

UpdateFiles Method (ArchiveWriter Class)

Updates a selection of files in the archive.

Syntax

int UpdateFiles(const QString& qsFolder, const QString& qsLocalPath, bool bAddMissingFiles, bool bRemoveMissingFiles, bool bRecursive);

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

Error Handling

UpdateVirtual Method (ArchiveWriter Class)

Updates an entry in the archive with on-the-fly content.

Syntax

int UpdateVirtual(const QString& qsPath);

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

Error Handling

AfterCompressFile Event (ArchiveWriter Class)

Marks the completion of compression of a file.

Syntax

class ArchiveWriterAfterCompressFileEventParams {
public:
  const QString &Path();

  qint64 FileSize();

  int DataSource();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AfterCompressFile(ArchiveWriterAfterCompressFileEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireAfterCompressFile(ArchiveWriterAfterCompressFileEventParams *e) {...}

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.


fdsFile (0)	The data was taken from a file.
fdsStream (1)	The data was taken from a stream assigned to FileStream property.
fdsBuffer (2)	The file data taken from the FileData buffer.

BeforeCompressFile Event (ArchiveWriter Class)

Marks the start of compression of a file.

Syntax

class ArchiveWriterBeforeCompressFileEventParams {
public:
  const QString &Path();

  qint64 FileSize();

  int DataSource();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BeforeCompressFile(ArchiveWriterBeforeCompressFileEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireBeforeCompressFile(ArchiveWriterBeforeCompressFileEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:


fdsFile (0)	The data will be taken from a file indicated by the entry's LocalPath setting. You can change this path in the handler of this event.
fdsStream (1)	The file data will be taken from a stream assigned to FileStream property.
fdsBuffer (2)	The data will be taken from a buffer attached to the FileData property.

If passing the data from a stream or buffer, use AfterCompressFile to dispose of any objects allocated in this event handler (such as the source stream).

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (ArchiveWriter Class)

Fires when the class needs a password to decrypt the archive.

Syntax

class ArchiveWriterDecryptionPasswordNeededEventParams {
public:
  const QString &PasswordTarget();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DecryptionPasswordNeeded(ArchiveWriterDecryptionPasswordNeededEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireDecryptionPasswordNeeded(ArchiveWriterDecryptionPasswordNeededEventParams *e) {...}

Remarks

Class fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation.

Error Event (ArchiveWriter Class)

Reports information about errors during archive assembling.

Syntax

class ArchiveWriterErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ArchiveWriterErrorEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireError(ArchiveWriterErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveWriter Class)

This event notifies the application about an underlying control flow event.

Syntax

class ArchiveWriterNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(ArchiveWriterNotificationEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireNotification(ArchiveWriterNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (ArchiveWriter Class)

Fires for every file to be compressed before the compression starts.

Syntax

class ArchiveWriterPrepareFileEventParams {
public:
  const QString &Path();

  qint64 FileSize();

  int DataSource();
  void SetDataSource(int iDataSource);

  const QString &LocalPath();
  void SetLocalPath(const QString &qsLocalPath);

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PrepareFile(ArchiveWriterPrepareFileEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FirePrepareFile(ArchiveWriterPrepareFileEventParams *e) {...}

Remarks

Class fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:


fdsFile (0)	The data will be taken from a file indicated by the LocalPath parameter. You can change this path in this event handler.
fdsStream (1)	The file data will be taken from a stream assigned to FileStream property.
fdsBuffer (2)	The data will be taken from a buffer attached to the FileData property.

Please do not assign FileStream or FileData in this event handler: this should be done further down the road in the BeforeCompressFile event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

The Action parameter, which is also tuneable, indicates the action for class to take on the file:


atAdd (0)	Add the file to the archive
atKeep (1)	Keep the existing file in the archive
atUpdate (2)	Update the archived file with a fresher copy
atDelete (3)	Delete the file from the archive
atExtract (4)	Extract the file (extraction only)
atSkip (5)	Skip file extraction (extraction only)

Progress Event (ArchiveWriter Class)

Reports the progress of data compression.

Syntax

class ArchiveWriterProgressEventParams {
public:
  qint64 Processed();

  qint64 Total();

  qint64 OverallProcessed();

  qint64 OverallTotal();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(ArchiveWriterProgressEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireProgress(ArchiveWriterProgressEventParams *e) {...}

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveWriter Class)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

class ArchiveWriterRecipientFoundEventParams {
public:
  const QByteArray &PublicKeyHash();

  bool CertFound();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RecipientFound(ArchiveWriterRecipientFoundEventParams *e);

// Or, subclass ArchiveWriter and override this emitter function.
virtual int FireRecipientFound(ArchiveWriterRecipientFoundEventParams *e) {...}

Remarks

The class fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: class won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

Configuration Settings (ArchiveWriter Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

ArchiveWriter Configuration Settings

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

UsePax: Enables use of PAX algorithm when creating TAR directories.

Use this setting to enable or disable the use of PAX algorithm when TARring directories.

UseUStar: Enables use of UStar variant of file name packaging when creating TAR directories.

Use this setting to enable or disable the use of UStar file name encoding format. This format allows for correct saving of path names longer than 99 characters in TAR archives.

Base Configuration Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (ArchiveWriter Class)

SecureBlackbox 2022 Qt Edition

ArchiveWriter Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

ArchiveType Property (ArchiveWriter Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

CompressionAlgorithm Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

CompressionLevel Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

DecryptionCertCount Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

DecryptionCertBytes Property (ArchiveWriter Class)

Syntax

Remarks

Data Type

DecryptionCertHandle Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

DecryptionPassword Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

EncryptionAlgorithm Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

EncryptionCertBytes Property (ArchiveWriter Class)

Syntax

Remarks

Data Type

EncryptionCertHandle Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

EncryptionKeyLength Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

EncryptionPassword Property (ArchiveWriter Class)

Syntax

Default Value

Remarks

Data Type

EncryptionType Property (ArchiveWriter Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

FileData Property (ArchiveWriter Class)

Syntax

Remarks

Data Type

FileCount Property (ArchiveWriter Class)

Syntax

Default Value