ArchiveWriter Class

Properties   Methods   Events   Config 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. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Creating or opening the archive.

Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' ACTION> and DATASOURCE> properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• AddFile - adds an entry with the contents of a local file.
• AddFiles - adds a set of files from a local directory.
• AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.

Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.

Property List

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

Method List

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

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.

Config Settings

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

ArchiveType Property (ArchiveWriter Class)

The type of the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArchiveType();

Unicode (Windows)
INT GetArchiveType();

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)

int secureblackbox_archivewriter_getarchivetype(void* lpObj);

int GetArchiveType();

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

Integer

CompressionAlgorithm Property (ArchiveWriter Class)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionAlgorithm();
int SetCompressionAlgorithm(int iCompressionAlgorithm);

Unicode (Windows)
INT GetCompressionAlgorithm();
INT SetCompressionAlgorithm(INT iCompressionAlgorithm);

int secureblackbox_archivewriter_getcompressionalgorithm(void* lpObj);
int secureblackbox_archivewriter_setcompressionalgorithm(void* lpObj, int iCompressionAlgorithm);

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

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

Data Type

Integer

CompressionLevel Property (ArchiveWriter Class)

The compression level to apply to the archived data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();
INT SetCompressionLevel(INT iCompressionLevel);

int secureblackbox_archivewriter_getcompressionlevel(void* lpObj);
int secureblackbox_archivewriter_setcompressionlevel(void* lpObj, int iCompressionLevel);

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

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

Data Type

Integer

DecryptionCertificates Property (ArchiveWriter Class)

A collection of decryption certificates.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetDecryptionCertificates();
int SetDecryptionCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_archivewriter_getdecryptioncertcount(void* lpObj);
int secureblackbox_archivewriter_setdecryptioncertcount(void* lpObj, int iDecryptionCertCount);

int secureblackbox_archivewriter_getdecryptioncertbytes(void* lpObj, int decryptioncertindex, char** lpDecryptionCertBytes, int* lenDecryptionCertBytes);

int64 secureblackbox_archivewriter_getdecryptioncerthandle(void* lpObj, int decryptioncertindex);
int secureblackbox_archivewriter_setdecryptioncerthandle(void* lpObj, int decryptioncertindex, int64 lDecryptionCertHandle);

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

QByteArray GetDecryptionCertBytes(int iDecryptionCertIndex);

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

Remarks

Use this property to provide a collection of decryption certificates. All certificates should contain their respective private keys.

When processing an encrypted document, the class will walk through the certificate list to locate the matching decryption certificate. If no such certificate is found, it will fire RecipientFound event to request it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

DecryptionPassword Property (ArchiveWriter Class)

The decryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionPassword();
int SetDecryptionPassword(const char* lpszDecryptionPassword);

Unicode (Windows)
LPWSTR GetDecryptionPassword();
INT SetDecryptionPassword(LPCWSTR lpszDecryptionPassword);

char* secureblackbox_archivewriter_getdecryptionpassword(void* lpObj);
int secureblackbox_archivewriter_setdecryptionpassword(void* lpObj, const char* lpszDecryptionPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);

char* secureblackbox_archivewriter_getencryptionalgorithm(void* lpObj);
int secureblackbox_archivewriter_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

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

EncryptionCertificate Property (ArchiveWriter Class)

The encryption certificate.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetEncryptionCertificate();
int SetEncryptionCertificate(SecureBlackboxCertificate* val);

int secureblackbox_archivewriter_getencryptioncertbytes(void* lpObj, char** lpEncryptionCertBytes, int* lenEncryptionCertBytes);

int64 secureblackbox_archivewriter_getencryptioncerthandle(void* lpObj);
int secureblackbox_archivewriter_setencryptioncerthandle(void* lpObj, int64 lEncryptionCertHandle);

QByteArray GetEncryptionCertBytes();

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

Remarks

Use this property to provide the encryption certificate.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

EncryptionKeyLength Property (ArchiveWriter Class)

The length of the encryption key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionKeyLength();
int SetEncryptionKeyLength(int iEncryptionKeyLength);

Unicode (Windows)
INT GetEncryptionKeyLength();
INT SetEncryptionKeyLength(INT iEncryptionKeyLength);

int secureblackbox_archivewriter_getencryptionkeylength(void* lpObj);
int secureblackbox_archivewriter_setencryptionkeylength(void* lpObj, int iEncryptionKeyLength);

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

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

Data Type

Integer

EncryptionPassword Property (ArchiveWriter Class)

Specifies the archive encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* secureblackbox_archivewriter_getencryptionpassword(void* lpObj);
int secureblackbox_archivewriter_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionType();
int SetEncryptionType(int iEncryptionType);

Unicode (Windows)
INT GetEncryptionType();
INT SetEncryptionType(INT iEncryptionType);

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

int secureblackbox_archivewriter_getencryptiontype(void* lpObj);
int secureblackbox_archivewriter_setencryptiontype(void* lpObj, int iEncryptionType);

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

Default Value

0

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileData(char* &lpFileData, int &lenFileData);
int SetFileData(const char* lpFileData, int lenFileData);

Unicode (Windows)
INT GetFileData(LPSTR &lpFileData, INT &lenFileData);
INT SetFileData(LPCSTR lpFileData, INT lenFileData);

int secureblackbox_archivewriter_getfiledata(void* lpObj, char** lpFileData, int* lenFileData);
int secureblackbox_archivewriter_setfiledata(void* lpObj, const char* lpFileData, int lenFileData);

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

Files Property (ArchiveWriter Class)

Lists the contents of the archive.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxArchivedFile>* GetFiles();

int secureblackbox_archivewriter_getfilecount(void* lpObj);
int secureblackbox_archivewriter_setfilecount(void* lpObj, int iFileCount);

int secureblackbox_archivewriter_getfileaction(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfileaction(void* lpObj, int fileindex, int iFileAction);

char* secureblackbox_archivewriter_getfileattributes(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfileattributes(void* lpObj, int fileindex, const char* lpszFileAttributes);

int64 secureblackbox_archivewriter_getfilecompressedsize(void* lpObj, int fileindex);

int secureblackbox_archivewriter_getfiledatasource(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfiledatasource(void* lpObj, int fileindex, int iFileDataSource);

int secureblackbox_archivewriter_getfiledirectory(void* lpObj, int fileindex);

char* secureblackbox_archivewriter_getfileencryptionalgorithm(void* lpObj, int fileindex);

int secureblackbox_archivewriter_getfileencryptionkeylength(void* lpObj, int fileindex);

int secureblackbox_archivewriter_getfileencryptiontype(void* lpObj, int fileindex);

char* secureblackbox_archivewriter_getfilefilename(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfilefilename(void* lpObj, int fileindex, const char* lpszFileFileName);

char* secureblackbox_archivewriter_getfilefolder(void* lpObj, int fileindex);

char* secureblackbox_archivewriter_getfilelocalpath(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfilelocalpath(void* lpObj, int fileindex, const char* lpszFileLocalPath);

char* secureblackbox_archivewriter_getfilemtime(void* lpObj, int fileindex);
int secureblackbox_archivewriter_setfilemtime(void* lpObj, int fileindex, const char* lpszFileMTime);

int secureblackbox_archivewriter_getfilenewfile(void* lpObj, int fileindex);

char* secureblackbox_archivewriter_getfilepath(void* lpObj, int fileindex);

int secureblackbox_archivewriter_getfilesignaturecount(void* lpObj, int fileindex);

int secureblackbox_archivewriter_getfilesigned(void* lpObj, int fileindex);

int64 secureblackbox_archivewriter_getfilesize(void* lpObj, int fileindex);

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

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

QString GetFileAttributes(int iFileIndex);
int SetFileAttributes(int iFileIndex, QString qsFileAttributes);

qint64 GetFileCompressedSize(int iFileIndex);

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

bool GetFileDirectory(int iFileIndex);

QString GetFileEncryptionAlgorithm(int iFileIndex);

int GetFileEncryptionKeyLength(int iFileIndex);

int GetFileEncryptionType(int iFileIndex);

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

QString GetFileFolder(int iFileIndex);

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

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

bool GetFileNewFile(int iFileIndex);

QString GetFilePath(int iFileIndex);

int GetFileSignatureCount(int iFileIndex);

bool GetFileSigned(int iFileIndex);

qint64 GetFileSize(int iFileIndex);

Remarks

This colletction property provides access to all files contained in the archive, both existing and newly added.

Use it to view or adjust properties of specific files, alter their data sources, and tune up actions to be performed on them.

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

Data Type

SecureBlackboxArchivedFile

FIPSMode Property (ArchiveWriter Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_archivewriter_getfipsmode(void* lpObj);
int secureblackbox_archivewriter_setfipsmode(void* lpObj, int bFIPSMode);

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

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (ArchiveWriter Class)

Specifies the hash algorithm to be used to generate the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_archivewriter_gethashalgorithm(void* lpObj);
int secureblackbox_archivewriter_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

This property is not available at design time.

Data Type

String

NewArchive Property (ArchiveWriter Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNewArchive();

Unicode (Windows)
BOOL GetNewArchive();

int secureblackbox_archivewriter_getnewarchive(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOpened();

Unicode (Windows)
BOOL GetOpened();

int secureblackbox_archivewriter_getopened(void* lpObj);

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

Overwrite Property (ArchiveWriter Class)

Whether the class should overwrite existing files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int secureblackbox_archivewriter_getoverwrite(void* lpObj);
int secureblackbox_archivewriter_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

Enable this property to force overwriting of existing files.

Data Type

Boolean

SigningCertificate Property (ArchiveWriter Class)

The certificate to be used for signing.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);

int secureblackbox_archivewriter_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

int64 secureblackbox_archivewriter_getsigningcerthandle(void* lpObj);
int secureblackbox_archivewriter_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);

QByteArray GetSigningCertBytes();

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

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SigningChain Property (ArchiveWriter Class)

The signing certificate chain.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain();
int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_archivewriter_getsigningchaincount(void* lpObj);
int secureblackbox_archivewriter_setsigningchaincount(void* lpObj, int iSigningChainCount);

int secureblackbox_archivewriter_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

int64 secureblackbox_archivewriter_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_archivewriter_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);

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

QByteArray GetSigningChainBytes(int iSigningChainIndex);

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

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

AddEmptyDir Method (ArchiveWriter Class)

Adds an empty folder to the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddEmptyDir(const char* lpszPath);

Unicode (Windows)
INT AddEmptyDir(LPCWSTR lpszPath);

int secureblackbox_archivewriter_addemptydir(void* lpObj, const char* lpszPath);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int AddFile(const char* lpszPath, const char* lpszLocalPath);

Unicode (Windows)
INT AddFile(LPCWSTR lpszPath, LPCWSTR lpszLocalPath);

int secureblackbox_archivewriter_addfile(void* lpObj, const char* lpszPath, const char* lpszLocalPath);

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 (C++)

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.

AddFiles Method (ArchiveWriter Class)

Adds a group of files to the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddFiles(const char* lpszFolder, const char* lpszLocalPath, int bRecursive);

Unicode (Windows)
INT AddFiles(LPCWSTR lpszFolder, LPCWSTR lpszLocalPath, BOOL bRecursive);

int secureblackbox_archivewriter_addfiles(void* lpObj, const char* lpszFolder, const char* lpszLocalPath, int bRecursive);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int AddVirtual(const char* lpszPath);

Unicode (Windows)
INT AddVirtual(LPCWSTR lpszPath);

int secureblackbox_archivewriter_addvirtual(void* lpObj, const char* lpszPath);

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 (C++)

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.

Close Method (ArchiveWriter Class)

Closes the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int secureblackbox_archivewriter_close(void* lpObj);

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 (C++)

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

Config Method (ArchiveWriter Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_archivewriter_config(void* lpObj, const char* lpszConfigurationString);

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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateNew(int iArchiveType);

Unicode (Windows)
INT CreateNew(INT iArchiveType);

int secureblackbox_archivewriter_createnew(void* lpObj, int iArchiveType);

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:

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

Error Handling (C++)

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

DoAction Method (ArchiveWriter Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_archivewriter_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Error Handling (C++)

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.

Open Method (ArchiveWriter Class)

Opens an archive file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open(int iArchiveType, const char* lpszArchiveName);

Unicode (Windows)
INT Open(INT iArchiveType, LPCWSTR lpszArchiveName);

int secureblackbox_archivewriter_open(void* lpObj, int iArchiveType, const char* lpszArchiveName);

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:

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

Error Handling (C++)

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

OpenBytes Method (ArchiveWriter Class)

Loads an archive file from a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenBytes(int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes);

Unicode (Windows)
INT OpenBytes(INT iArchiveType, LPCSTR lpArchiveBytes, INT lenArchiveBytes);

int secureblackbox_archivewriter_openbytes(void* lpObj, int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes);

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:

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

Error Handling (C++)

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

OpenStream Method (ArchiveWriter Class)

Loads an archive file from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenStream(int iArchiveType, SecureBlackboxStream* sArchiveStream);

Unicode (Windows)
INT OpenStream(INT iArchiveType, SecureBlackboxStream* sArchiveStream);

int secureblackbox_archivewriter_openstream(void* lpObj, int iArchiveType, SecureBlackboxStream* sArchiveStream);

int OpenStream(int iArchiveType, SecureBlackboxStream* sArchiveStream);

Remarks

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

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

The following archive types are currently supported:

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

Error Handling (C++)

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

Remove Method (ArchiveWriter Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Remove(const char* lpszPath);

Unicode (Windows)
INT Remove(LPCWSTR lpszPath);

int secureblackbox_archivewriter_remove(void* lpObj, const char* lpszPath);

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 (C++)

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

Reset Method (ArchiveWriter Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_archivewriter_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

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

Save Method (ArchiveWriter Class)

Compresses the archive and saves it to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Save(const char* lpszArchiveName);

Unicode (Windows)
INT Save(LPCWSTR lpszArchiveName);

int secureblackbox_archivewriter_save(void* lpObj, const char* lpszArchiveName);

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 (C++)

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

SaveBytes Method (ArchiveWriter Class)

Compresses the archive and saves it to a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SaveBytes(int *lpSize = NULL);

Unicode (Windows)
LPSTR SaveBytes(LPINT lpSize = NULL);

char* secureblackbox_archivewriter_savebytes(void* lpObjint *lpSize);

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 (C++)

This method returns a Byte Array value (with length lpSize); 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.

SaveStream Method (ArchiveWriter Class)

Compresses the archive and saves it to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveStream(SecureBlackboxStream* sArchiveStream);

Unicode (Windows)
INT SaveStream(SecureBlackboxStream* sArchiveStream);

int secureblackbox_archivewriter_savestream(void* lpObj, SecureBlackboxStream* sArchiveStream);

int SaveStream(SecureBlackboxStream* sArchiveStream);

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection to ArchiveStream.

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 (C++)

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

UpdateFile Method (ArchiveWriter Class)

Updates an existing compressed entry with a fresher local version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateFile(const char* lpszPath, const char* lpszLocalPath);

Unicode (Windows)
INT UpdateFile(LPCWSTR lpszPath, LPCWSTR lpszLocalPath);

int secureblackbox_archivewriter_updatefile(void* lpObj, const char* lpszPath, const char* lpszLocalPath);

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 (C++)

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

UpdateFiles Method (ArchiveWriter Class)

Updates a selection of files in the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateFiles(const char* lpszFolder, const char* lpszLocalPath, int bAddMissingFiles, int bRemoveMissingFiles, int bRecursive);

Unicode (Windows)
INT UpdateFiles(LPCWSTR lpszFolder, LPCWSTR lpszLocalPath, BOOL bAddMissingFiles, BOOL bRemoveMissingFiles, BOOL bRecursive);

int secureblackbox_archivewriter_updatefiles(void* lpObj, const char* lpszFolder, const char* lpszLocalPath, int bAddMissingFiles, int bRemoveMissingFiles, int bRecursive);

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 (C++)

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

UpdateVirtual Method (ArchiveWriter Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateVirtual(const char* lpszPath);

Unicode (Windows)
INT UpdateVirtual(LPCWSTR lpszPath);

int secureblackbox_archivewriter_updatevirtual(void* lpObj, const char* lpszPath);

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 (C++)

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

ActionNeeded Event (ArchiveWriter Class)

Requests a decision from the application in case of a conflict.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireActionNeeded(ArchiveWriterActionNeededEventParams *e);

typedef struct {
  int WhatFor;
  const char *EntryPath;
  const char *DestPath;
  const char *Description;
  int Action;
  int reserved;
} ArchiveWriterActionNeededEventParams;


Unicode (Windows)
virtual INT FireActionNeeded(ArchiveWriterActionNeededEventParams *e);

typedef struct {
  INT WhatFor;
  LPCWSTR EntryPath;
  LPCWSTR DestPath;
  LPCWSTR Description;
  INT Action;
  INT reserved;
} ArchiveWriterActionNeededEventParams;

#define EID_ARCHIVEWRITER_ACTIONNEEDED 1

virtual INT SECUREBLACKBOX_CALL FireActionNeeded(INT &iWhatFor, LPSTR &lpszEntryPath, LPSTR &lpszDestPath, LPSTR &lpszDescription, INT &iAction);

class ArchiveWriterActionNeededEventParams {
public:
  int WhatFor();

  const QString &EntryPath();

  const QString &DestPath();

  const QString &Description();

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

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

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

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

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (ArchiveWriter Class)

Marks the completion of compression of a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAfterCompressFile(ArchiveWriterAfterCompressFileEventParams *e);

typedef struct {
  const char *Path;
  int64 FileSize;
  int DataSource;
  int reserved;
} ArchiveWriterAfterCompressFileEventParams;


Unicode (Windows)
virtual INT FireAfterCompressFile(ArchiveWriterAfterCompressFileEventParams *e);

typedef struct {
  LPCWSTR Path;
  LONG64 FileSize;
  INT DataSource;
  INT reserved;
} ArchiveWriterAfterCompressFileEventParams;

#define EID_ARCHIVEWRITER_AFTERCOMPRESSFILE 2

virtual INT SECUREBLACKBOX_CALL FireAfterCompressFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource);

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.

BeforeCompressFile Event (ArchiveWriter Class)

Marks the start of compression of a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBeforeCompressFile(ArchiveWriterBeforeCompressFileEventParams *e);

typedef struct {
  const char *Path;
  int64 FileSize;
  int DataSource;
  int reserved;
} ArchiveWriterBeforeCompressFileEventParams;


Unicode (Windows)
virtual INT FireBeforeCompressFile(ArchiveWriterBeforeCompressFileEventParams *e);

typedef struct {
  LPCWSTR Path;
  LONG64 FileSize;
  INT DataSource;
  INT reserved;
} ArchiveWriterBeforeCompressFileEventParams;

#define EID_ARCHIVEWRITER_BEFORECOMPRESSFILE 3

virtual INT SECUREBLACKBOX_CALL FireBeforeCompressFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource);

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:

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDecryptionPasswordNeeded(ArchiveWriterDecryptionPasswordNeededEventParams *e);

typedef struct {
  const char *PasswordTarget;
  int Cancel;
  int reserved;
} ArchiveWriterDecryptionPasswordNeededEventParams;


Unicode (Windows)
virtual INT FireDecryptionPasswordNeeded(ArchiveWriterDecryptionPasswordNeededEventParams *e);

typedef struct {
  LPCWSTR PasswordTarget;
  BOOL Cancel;
  INT reserved;
} ArchiveWriterDecryptionPasswordNeededEventParams;

#define EID_ARCHIVEWRITER_DECRYPTIONPASSWORDNEEDED 4

virtual INT SECUREBLACKBOX_CALL FireDecryptionPasswordNeeded(LPSTR &lpszPasswordTarget, BOOL &bCancel);

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. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveWriter Class)

Reports information about errors during archive assembling.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(ArchiveWriterErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ArchiveWriterErrorEventParams;


Unicode (Windows)
virtual INT FireError(ArchiveWriterErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ArchiveWriterErrorEventParams;

#define EID_ARCHIVEWRITER_ERROR 5

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(ArchiveWriterNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} ArchiveWriterNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(ArchiveWriterNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} ArchiveWriterNotificationEventParams;

#define EID_ARCHIVEWRITER_NOTIFICATION 6

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

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 class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, 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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePrepareFile(ArchiveWriterPrepareFileEventParams *e);

typedef struct {
  const char *Path;
  int64 FileSize;
  int DataSource;
  char *LocalPath;
  int Action;
  int reserved;
} ArchiveWriterPrepareFileEventParams;


Unicode (Windows)
virtual INT FirePrepareFile(ArchiveWriterPrepareFileEventParams *e);

typedef struct {
  LPCWSTR Path;
  LONG64 FileSize;
  INT DataSource;
  LPWSTR LocalPath;
  INT Action;
  INT reserved;
} ArchiveWriterPrepareFileEventParams;

#define EID_ARCHIVEWRITER_PREPAREFILE 7

virtual INT SECUREBLACKBOX_CALL FirePrepareFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource, LPSTR &lpszLocalPath, INT &iAction);

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:

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

Progress Event (ArchiveWriter Class)

Reports the progress of data compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(ArchiveWriterProgressEventParams *e);

typedef struct {
  int64 Processed;
  int64 Total;
  int64 OverallProcessed;
  int64 OverallTotal;
  int Cancel;
  int reserved;
} ArchiveWriterProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(ArchiveWriterProgressEventParams *e);

typedef struct {
  LONG64 Processed;
  LONG64 Total;
  LONG64 OverallProcessed;
  LONG64 OverallTotal;
  BOOL Cancel;
  INT reserved;
} ArchiveWriterProgressEventParams;

#define EID_ARCHIVEWRITER_PROGRESS 8

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lProcessed, LONG64 &lTotal, LONG64 &lOverallProcessed, LONG64 &lOverallTotal, BOOL &bCancel);

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientFound(ArchiveWriterRecipientFoundEventParams *e);

typedef struct {
  const char *PublicKeyHash;
  int CertFound;
  int reserved;
} ArchiveWriterRecipientFoundEventParams;


Unicode (Windows)
virtual INT FireRecipientFound(ArchiveWriterRecipientFoundEventParams *e);

typedef struct {
  LPCWSTR PublicKeyHash;
  BOOL CertFound;
  INT reserved;
} ArchiveWriterRecipientFoundEventParams;

#define EID_ARCHIVEWRITER_RECIPIENTFOUND 9

virtual INT SECUREBLACKBOX_CALL FireRecipientFound(LPSTR &lpszPublicKeyHash, BOOL &bCertFound);

class ArchiveWriterRecipientFoundEventParams {
public:
  const QString &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.

ArchivedFile Type

Provides information about the compressed file.

Syntax

SecureBlackboxArchivedFile (declared in secureblackbox.h)

Remarks

Use this type to access compressed file details.

Fields

Constructors

ArchivedFile()

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

Certificate()

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the ArchiveWriter class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The ArchiveWriter class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the ArchiveWriter class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (ArchiveWriter Class)

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.