ArchiveReader Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveReader class supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.

Syntax

ArchiveReader

Remarks

ArchiveReader shows and extracts archived files.

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 (ArchiveReader Class)

The type of the archive file.

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_archivereader_getarchivetype(void* lpObj);

int GetArchiveType();

Default Value

0

Remarks

Use this property to learn about the type (format) of the opened archive.

This property is read-only.

Data Type

Integer

DecryptionCertCount Property (ArchiveReader Class)

The number of records in the DecryptionCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertCount();
int SetDecryptionCertCount(int iDecryptionCertCount);

Unicode (Windows)
INT GetDecryptionCertCount();
INT SetDecryptionCertCount(INT iDecryptionCertCount);

int secureblackbox_archivereader_getdecryptioncertcount(void* lpObj);
int secureblackbox_archivereader_setdecryptioncertcount(void* lpObj, int iDecryptionCertCount);

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

Default Value

0

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 (ArchiveReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertBytes(int iDecryptionCertIndex, char* &lpDecryptionCertBytes, int &lenDecryptionCertBytes);

Unicode (Windows)
INT GetDecryptionCertBytes(INT iDecryptionCertIndex, LPSTR &lpDecryptionCertBytes, INT &lenDecryptionCertBytes);

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

QByteArray GetDecryptionCertBytes(int iDecryptionCertIndex);

Remarks

Returns the 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 (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetDecryptionCertHandle(int iDecryptionCertIndex);
int SetDecryptionCertHandle(int iDecryptionCertIndex, int64 lDecryptionCertHandle);

Unicode (Windows)
LONG64 GetDecryptionCertHandle(INT iDecryptionCertIndex);
INT SetDecryptionCertHandle(INT iDecryptionCertIndex, LONG64 lDecryptionCertHandle);

int64 secureblackbox_archivereader_getdecryptioncerthandle(void* lpObj, int decryptioncertindex);
int secureblackbox_archivereader_setdecryptioncerthandle(void* lpObj, int decryptioncertindex, int64 lDecryptionCertHandle);

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

Default Value

0

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.

 
 Copy
  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 (ArchiveReader 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_archivereader_getdecryptionpassword(void* lpObj);
int secureblackbox_archivereader_setdecryptionpassword(void* lpObj, const char* lpszDecryptionPassword);

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

Default Value

""

Remarks

Use this property to provide the decryption password for the archive.

Data Type

String

FileData Property (ArchiveReader Class)

The contents of the last extracted file.

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_archivereader_getfiledata(void* lpObj, char** lpFileData, int* lenFileData);
int secureblackbox_archivereader_setfiledata(void* lpObj, const char* lpFileData, int lenFileData);

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

Remarks

Use this property to get the contents of the last extracted file with DataSource set to stBuffer (2).

This property is not available at design time.

Data Type

Byte Array

FileCount Property (ArchiveReader Class)

The number of records in the File arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileCount();
int SetFileCount(int iFileCount);

Unicode (Windows)
INT GetFileCount();
INT SetFileCount(INT iFileCount);

int secureblackbox_archivereader_getfilecount(void* lpObj);
int secureblackbox_archivereader_setfilecount(void* lpObj, int iFileCount);

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

Default Value

0

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 (ArchiveReader Class)

The action to apply to the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileAction(int iFileIndex);
int SetFileAction(int iFileIndex, int iFileAction);

Unicode (Windows)
INT GetFileAction(INT iFileIndex);
INT SetFileAction(INT iFileIndex, INT iFileAction);

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

int secureblackbox_archivereader_getfileaction(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfileaction(void* lpObj, int fileindex, int iFileAction);

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

Default Value

0

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:

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 (ArchiveReader Class)

The size of the file after compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetFileCompressedSize(int iFileIndex);

Unicode (Windows)
LONG64 GetFileCompressedSize(INT iFileIndex);

int64 secureblackbox_archivereader_getfilecompressedsize(void* lpObj, int fileindex);

qint64 GetFileCompressedSize(int iFileIndex);

Default Value

0

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 (ArchiveReader Class)

The type of the data source for this entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileDataSource(int iFileIndex);
int SetFileDataSource(int iFileIndex, int iFileDataSource);

Unicode (Windows)
INT GetFileDataSource(INT iFileIndex);
INT SetFileDataSource(INT iFileIndex, INT iFileDataSource);

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

int secureblackbox_archivereader_getfiledatasource(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfiledatasource(void* lpObj, int fileindex, int iFileDataSource);

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

Default Value

0

Remarks

The type of the data source for this entry.

Use this property to control the data source for this 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 not available at design time.

Data Type

Integer

FileDirectory Property (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileDirectory(int iFileIndex);

Unicode (Windows)
BOOL GetFileDirectory(INT iFileIndex);

int secureblackbox_archivereader_getfiledirectory(void* lpObj, int fileindex);

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 (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileEncryptionAlgorithm(int iFileIndex);

Unicode (Windows)
LPWSTR GetFileEncryptionAlgorithm(INT iFileIndex);

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

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 (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileEncryptionKeyLength(int iFileIndex);

Unicode (Windows)
INT GetFileEncryptionKeyLength(INT iFileIndex);

int secureblackbox_archivereader_getfileencryptionkeylength(void* lpObj, int fileindex);

int GetFileEncryptionKeyLength(int iFileIndex);

Default Value

0

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 (ArchiveReader Class)

The type of encryption applied to the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileEncryptionType(int iFileIndex);

Unicode (Windows)
INT GetFileEncryptionType(INT iFileIndex);

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

int secureblackbox_archivereader_getfileencryptiontype(void* lpObj, int fileindex);

int GetFileEncryptionType(int iFileIndex);

Default Value

0

Remarks

The type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to 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

Integer

FileFileName Property (ArchiveReader Class)

The original name of the compressed file or folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileFileName(int iFileIndex);
int SetFileFileName(int iFileIndex, const char* lpszFileFileName);

Unicode (Windows)
LPWSTR GetFileFileName(INT iFileIndex);
INT SetFileFileName(INT iFileIndex, LPCWSTR lpszFileFileName);

char* secureblackbox_archivereader_getfilefilename(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilefilename(void* lpObj, int fileindex, const char* lpszFileFileName);

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 (ArchiveReader Class)

The containing folder of the entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileFolder(int iFileIndex);

Unicode (Windows)
LPWSTR GetFileFolder(INT iFileIndex);

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

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 (ArchiveReader Class)

The local path associated with this entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileLocalPath(int iFileIndex);
int SetFileLocalPath(int iFileIndex, const char* lpszFileLocalPath);

Unicode (Windows)
LPWSTR GetFileLocalPath(INT iFileIndex);
INT SetFileLocalPath(INT iFileIndex, LPCWSTR lpszFileLocalPath);

char* secureblackbox_archivereader_getfilelocalpath(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilelocalpath(void* lpObj, int fileindex, const char* lpszFileLocalPath);

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 (ArchiveReader Class)

The entry's last modification time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileMTime(int iFileIndex);
int SetFileMTime(int iFileIndex, const char* lpszFileMTime);

Unicode (Windows)
LPWSTR GetFileMTime(INT iFileIndex);
INT SetFileMTime(INT iFileIndex, LPCWSTR lpszFileMTime);

char* secureblackbox_archivereader_getfilemtime(void* lpObj, int fileindex);
int secureblackbox_archivereader_setfilemtime(void* lpObj, int fileindex, const char* lpszFileMTime);

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 (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileNewFile(int iFileIndex);

Unicode (Windows)
BOOL GetFileNewFile(INT iFileIndex);

int secureblackbox_archivereader_getfilenewfile(void* lpObj, int fileindex);

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 (ArchiveReader Class)

The full internal path of the archived entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFilePath(int iFileIndex);

Unicode (Windows)
LPWSTR GetFilePath(INT iFileIndex);

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

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 (ArchiveReader Class)

The number of signatures covering the entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileSignatureCount(int iFileIndex);

Unicode (Windows)
INT GetFileSignatureCount(INT iFileIndex);

int secureblackbox_archivereader_getfilesignaturecount(void* lpObj, int fileindex);

int GetFileSignatureCount(int iFileIndex);

Default Value

0

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 (ArchiveReader Class)

Indicates whether the entry is signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileSigned(int iFileIndex);

Unicode (Windows)
BOOL GetFileSigned(INT iFileIndex);

int secureblackbox_archivereader_getfilesigned(void* lpObj, int fileindex);

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 (ArchiveReader Class)

The size of the file before compression.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetFileSize(int iFileIndex);

Unicode (Windows)
LONG64 GetFileSize(INT iFileIndex);

int64 secureblackbox_archivereader_getfilesize(void* lpObj, int fileindex);

qint64 GetFileSize(int iFileIndex);

Default Value

0

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 (ArchiveReader 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_archivereader_getfipsmode(void* lpObj);
int secureblackbox_archivereader_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 (ArchiveReader Class)

Returns the hash algorithm that was used to generate the signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();

Unicode (Windows)
LPWSTR GetHashAlgorithm();

char* secureblackbox_archivereader_gethashalgorithm(void* lpObj);

QString GetHashAlgorithm();

Default Value

""

Remarks

Check this property after calling Extract to get the hash algorithm which was used to calculate the signature.

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

Data Type

String

KnownCertCount Property (ArchiveReader Class)

The number of records in the KnownCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_archivereader_getknowncertcount(void* lpObj);
int secureblackbox_archivereader_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (ArchiveReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_archivereader_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_archivereader_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_archivereader_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

Opened Property (ArchiveReader Class)

Indicates if the class is in the open state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOpened();

Unicode (Windows)
BOOL GetOpened();

int secureblackbox_archivereader_getopened(void* lpObj);

bool GetOpened();

Default Value

FALSE

Remarks

Use this property to check if the component provides access to an open archive file.

This property is read-only.

Data Type

Boolean

SignatureValidationResult Property (ArchiveReader Class)

The signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureValidationResult();

Unicode (Windows)
INT GetSignatureValidationResult();

SVT_VALID(0), 
SVT_UNKNOWN(1), 
SVT_CORRUPTED(2), 
SVT_SIGNER_NOT_FOUND(3), 
SVT_FAILURE(4)

int secureblackbox_archivereader_getsignaturevalidationresult(void* lpObj);

int GetSignatureValidationResult();

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

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

Data Type

Integer

SigningCertBytes Property (ArchiveReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertBytes(char* &lpSigningCertBytes, int &lenSigningCertBytes);

Unicode (Windows)
INT GetSigningCertBytes(LPSTR &lpSigningCertBytes, INT &lenSigningCertBytes);

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

QByteArray GetSigningCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertCA Property (ArchiveReader Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertCA();

Unicode (Windows)
BOOL GetSigningCertCA();

int secureblackbox_archivereader_getsigningcertca(void* lpObj);

bool GetSigningCertCA();

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

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

Data Type

Boolean

SigningCertCAKeyID Property (ArchiveReader Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertCAKeyID(char* &lpSigningCertCAKeyID, int &lenSigningCertCAKeyID);

Unicode (Windows)
INT GetSigningCertCAKeyID(LPSTR &lpSigningCertCAKeyID, INT &lenSigningCertCAKeyID);

int secureblackbox_archivereader_getsigningcertcakeyid(void* lpObj, char** lpSigningCertCAKeyID, int* lenSigningCertCAKeyID);

QByteArray GetSigningCertCAKeyID();

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (ArchiveReader Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertCRLDistributionPoints();

Unicode (Windows)
LPWSTR GetSigningCertCRLDistributionPoints();

char* secureblackbox_archivereader_getsigningcertcrldistributionpoints(void* lpObj);

QString GetSigningCertCRLDistributionPoints();

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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

Data Type

String

SigningCertCurve Property (ArchiveReader Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertCurve();

Unicode (Windows)
LPWSTR GetSigningCertCurve();

char* secureblackbox_archivereader_getsigningcertcurve(void* lpObj);

QString GetSigningCertCurve();

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

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

Data Type

String

SigningCertFingerprint Property (ArchiveReader Class)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertFingerprint(char* &lpSigningCertFingerprint, int &lenSigningCertFingerprint);

Unicode (Windows)
INT GetSigningCertFingerprint(LPSTR &lpSigningCertFingerprint, INT &lenSigningCertFingerprint);

int secureblackbox_archivereader_getsigningcertfingerprint(void* lpObj, char** lpSigningCertFingerprint, int* lenSigningCertFingerprint);

QByteArray GetSigningCertFingerprint();

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

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

Data Type

Byte Array

SigningCertFriendlyName Property (ArchiveReader Class)

Contains an associated alias (friendly name) of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertFriendlyName();

Unicode (Windows)
LPWSTR GetSigningCertFriendlyName();

char* secureblackbox_archivereader_getsigningcertfriendlyname(void* lpObj);

QString GetSigningCertFriendlyName();

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

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

Data Type

String

SigningCertHandle Property (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSigningCertHandle();

Unicode (Windows)
LONG64 GetSigningCertHandle();

int64 secureblackbox_archivereader_getsigningcerthandle(void* lpObj);

qint64 GetSigningCertHandle();

Default Value

0

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

SigningCertHashAlgorithm Property (ArchiveReader Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertHashAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertHashAlgorithm();

char* secureblackbox_archivereader_getsigningcerthashalgorithm(void* lpObj);

QString GetSigningCertHashAlgorithm();

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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

Data Type

String

SigningCertIssuer Property (ArchiveReader Class)

The common name of the certificate issuer (CA), typically a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertIssuer();

Unicode (Windows)
LPWSTR GetSigningCertIssuer();

char* secureblackbox_archivereader_getsigningcertissuer(void* lpObj);

QString GetSigningCertIssuer();

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

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

Data Type

String

SigningCertIssuerRDN Property (ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertIssuerRDN();

Unicode (Windows)
LPWSTR GetSigningCertIssuerRDN();

char* secureblackbox_archivereader_getsigningcertissuerrdn(void* lpObj);

QString GetSigningCertIssuerRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

Data Type

String

SigningCertKeyAlgorithm Property (ArchiveReader Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertKeyAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertKeyAlgorithm();

char* secureblackbox_archivereader_getsigningcertkeyalgorithm(void* lpObj);

QString GetSigningCertKeyAlgorithm();

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

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

Data Type

String

SigningCertKeyBits Property (ArchiveReader Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertKeyBits();

Unicode (Windows)
INT GetSigningCertKeyBits();

int secureblackbox_archivereader_getsigningcertkeybits(void* lpObj);

int GetSigningCertKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

SigningCertKeyFingerprint Property (ArchiveReader Class)

Returns a fingerprint of the public key contained in the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertKeyFingerprint(char* &lpSigningCertKeyFingerprint, int &lenSigningCertKeyFingerprint);

Unicode (Windows)
INT GetSigningCertKeyFingerprint(LPSTR &lpSigningCertKeyFingerprint, INT &lenSigningCertKeyFingerprint);

int secureblackbox_archivereader_getsigningcertkeyfingerprint(void* lpObj, char** lpSigningCertKeyFingerprint, int* lenSigningCertKeyFingerprint);

QByteArray GetSigningCertKeyFingerprint();

Remarks

Returns a fingerprint of the public key contained in the certificate.

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

Data Type

Byte Array

SigningCertKeyUsage Property (ArchiveReader Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertKeyUsage();

Unicode (Windows)
INT GetSigningCertKeyUsage();

int secureblackbox_archivereader_getsigningcertkeyusage(void* lpObj);

int GetSigningCertKeyUsage();

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

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

Data Type

Integer

SigningCertKeyValid Property (ArchiveReader Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertKeyValid();

Unicode (Windows)
BOOL GetSigningCertKeyValid();

int secureblackbox_archivereader_getsigningcertkeyvalid(void* lpObj);

bool GetSigningCertKeyValid();

Default Value

FALSE

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

SigningCertOCSPLocations Property (ArchiveReader Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertOCSPLocations();

Unicode (Windows)
LPWSTR GetSigningCertOCSPLocations();

char* secureblackbox_archivereader_getsigningcertocsplocations(void* lpObj);

QString GetSigningCertOCSPLocations();

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

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

Data Type

String

SigningCertPolicyIDs Property (ArchiveReader Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertPolicyIDs();

Unicode (Windows)
LPWSTR GetSigningCertPolicyIDs();

char* secureblackbox_archivereader_getsigningcertpolicyids(void* lpObj);

QString GetSigningCertPolicyIDs();

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

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

Data Type

String

SigningCertPublicKeyBytes Property (ArchiveReader Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertPublicKeyBytes(char* &lpSigningCertPublicKeyBytes, int &lenSigningCertPublicKeyBytes);

Unicode (Windows)
INT GetSigningCertPublicKeyBytes(LPSTR &lpSigningCertPublicKeyBytes, INT &lenSigningCertPublicKeyBytes);

int secureblackbox_archivereader_getsigningcertpublickeybytes(void* lpObj, char** lpSigningCertPublicKeyBytes, int* lenSigningCertPublicKeyBytes);

QByteArray GetSigningCertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

SigningCertSelfSigned Property (ArchiveReader Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertSelfSigned();

Unicode (Windows)
BOOL GetSigningCertSelfSigned();

int secureblackbox_archivereader_getsigningcertselfsigned(void* lpObj);

bool GetSigningCertSelfSigned();

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

Data Type

Boolean

SigningCertSerialNumber Property (ArchiveReader Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertSerialNumber(char* &lpSigningCertSerialNumber, int &lenSigningCertSerialNumber);

Unicode (Windows)
INT GetSigningCertSerialNumber(LPSTR &lpSigningCertSerialNumber, INT &lenSigningCertSerialNumber);

int secureblackbox_archivereader_getsigningcertserialnumber(void* lpObj, char** lpSigningCertSerialNumber, int* lenSigningCertSerialNumber);

QByteArray GetSigningCertSerialNumber();

Remarks

Returns the certificate's serial number.

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (ArchiveReader Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertSigAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertSigAlgorithm();

char* secureblackbox_archivereader_getsigningcertsigalgorithm(void* lpObj);

QString GetSigningCertSigAlgorithm();

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

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

Data Type

String

SigningCertSubject Property (ArchiveReader Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertSubject();

Unicode (Windows)
LPWSTR GetSigningCertSubject();

char* secureblackbox_archivereader_getsigningcertsubject(void* lpObj);

QString GetSigningCertSubject();

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

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

Data Type

String

SigningCertSubjectKeyID Property (ArchiveReader Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertSubjectKeyID(char* &lpSigningCertSubjectKeyID, int &lenSigningCertSubjectKeyID);

Unicode (Windows)
INT GetSigningCertSubjectKeyID(LPSTR &lpSigningCertSubjectKeyID, INT &lenSigningCertSubjectKeyID);

int secureblackbox_archivereader_getsigningcertsubjectkeyid(void* lpObj, char** lpSigningCertSubjectKeyID, int* lenSigningCertSubjectKeyID);

QByteArray GetSigningCertSubjectKeyID();

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

Data Type

Byte Array

SigningCertSubjectRDN Property (ArchiveReader Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertSubjectRDN();

Unicode (Windows)
LPWSTR GetSigningCertSubjectRDN();

char* secureblackbox_archivereader_getsigningcertsubjectrdn(void* lpObj);

QString GetSigningCertSubjectRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

Data Type

String

SigningCertValidFrom Property (ArchiveReader Class)

The time point at which the certificate becomes valid, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertValidFrom();

Unicode (Windows)
LPWSTR GetSigningCertValidFrom();

char* secureblackbox_archivereader_getsigningcertvalidfrom(void* lpObj);

QString GetSigningCertValidFrom();

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

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

Data Type

String

SigningCertValidTo Property (ArchiveReader Class)

The time point at which the certificate expires, in UTC.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertValidTo();

Unicode (Windows)
LPWSTR GetSigningCertValidTo();

char* secureblackbox_archivereader_getsigningcertvalidto(void* lpObj);

QString GetSigningCertValidTo();

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

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

Data Type

String

Close Method (ArchiveReader Class)

Closes the current archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int secureblackbox_archivereader_close(void* lpObj);

int Close();

Remarks

Use this method to close the archive that is currently opened and release the associated memory. You won't be able to extract files or access the archive details after closing 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 (ArchiveReader 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_archivereader_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.

DoAction Method (ArchiveReader 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_archivereader_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;....

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.

Extract Method (ArchiveReader Class)

Extracts a single file from the archive.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Extract(LPCWSTR lpszPath, LPCWSTR lpszLocalPath, BOOL bPreserveFullPath);

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

int Extract(const QString& qsPath, const QString& qsLocalPath, bool bPreserveFullPath);

Remarks

Use this method to extract a single file from the archive.

Pass the internal path to the entry in the archive via the Path parameter, and the path where to save the extracted entry via the LocalPath parameter. Set PreserveFullPath to true to enforce full-path extraction, in which case LocalPath would indicate the mount point at which the full Path needs to be rooted. If PreserveFullPath is false, the LocalPath provides the final location for the extracted file.

Use ExtractAll to extract all files at once.

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

ExtractAll Method (ArchiveReader Class)

Extract all the files contained in the archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExtractAll(const char* lpszOutputPath, int bOverwriteExisting);

Unicode (Windows)
INT ExtractAll(LPCWSTR lpszOutputPath, BOOL bOverwriteExisting);

int secureblackbox_archivereader_extractall(void* lpObj, const char* lpszOutputPath, int bOverwriteExisting);

int ExtractAll(const QString& qsOutputPath, bool bOverwriteExisting);

Remarks

Use this method to extract all the files contained in the archive file. Pass the path where the extracted files should be saved via the OutputPath parameter. Existing files will be overwritten if the OverwriteExisting parameter is set to true.

You can cherry-pick the files to extract, as well as choose different extraction destinations (including files at custom locations, streams, or memory buffers) by subscribing to BeforeExtractFile and AfterExtractFile events.

Use Extract to extract a single file.

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

Open Method (ArchiveReader Class)

Opens an archive file.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_archivereader_open(void* lpObj, int iArchiveType, const char* lpszArchivePath);

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

Remarks

Call this method to open an archive file. Provide the archive type via the ArchiveType parameter, and the path via the ArchivePath parameter.

The following archive types (formats) are supported:

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 (ArchiveReader 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_archivereader_openbytes(void* lpObj, int iArchiveType, const char* lpArchiveBytes, int lenArchiveBytes);

int OpenBytes(int iArchiveType, QByteArray qbaArchiveBytes);

Remarks

Call this method to load an archive file from a byte array. Provide the archive type via the ArchiveType parameter, and the byte array containing the archive data via the ArchiveBytes parameter.

The following archive types (formats) are supported:

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 (ArchiveReader 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_archivereader_openstream(void* lpObj, int iArchiveType, SecureBlackboxStream* sArchiveStream);

int OpenStream(int iArchiveType, SecureBlackboxStream* sArchiveStream);

Remarks

Call this method to load an archive file from a stream. Provide the archive type via the ArchiveType parameter, and the stream containing the archive data via the ArchiveStream parameter.

The following archive types (formats) are supported:

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

AfterExtractFile Event (ArchiveReader Class)

Marks the completion of extraction of an archived file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e);

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


Unicode (Windows)
virtual INT FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e);

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

#define EID_ARCHIVEREADER_AFTEREXTRACTFILE 1

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

class ArchiveReaderAfterExtractFileEventParams {
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 AfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e);

// Or, subclass ArchiveReader and override this emitter function.
virtual int FireAfterExtractFile(ArchiveReaderAfterExtractFileEventParams *e) {...}

Remarks

Subscribe to this event to get notified about the completion of extraction of an archived file.

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

BeforeExtractFile Event (ArchiveReader Class)

Marks the start of extraction of an archived file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e);

typedef struct {
  const char *Path;
  int64 FileSize;
  int DataSource;
  char *ExtractionPath;
  int Skip;
  int reserved;
} ArchiveReaderBeforeExtractFileEventParams;


Unicode (Windows)
virtual INT FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e);

typedef struct {
  LPCWSTR Path;
  LONG64 FileSize;
  INT DataSource;
  LPWSTR ExtractionPath;
  BOOL Skip;
  INT reserved;
} ArchiveReaderBeforeExtractFileEventParams;

#define EID_ARCHIVEREADER_BEFOREEXTRACTFILE 2

virtual INT SECUREBLACKBOX_CALL FireBeforeExtractFile(LPSTR &lpszPath, LONG64 &lFileSize, INT &iDataSource, LPSTR &lpszExtractionPath, BOOL &bSkip);

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

  qint64 FileSize();

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

  const QString &ExtractionPath();
  void SetExtractionPath(const QString &qsExtractionPath);

  bool Skip();
  void SetSkip(bool bSkip);

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

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

// Or, subclass ArchiveReader and override this emitter function.
virtual int FireBeforeExtractFile(ArchiveReaderBeforeExtractFileEventParams *e) {...}

Remarks

Subscribe to this event to be notified about the start of extraction of an archived entry. The handler of this event is a good place to tune up the destination media.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the uncompressed size of the file. Set the by-reference DataSource parameter in accordance with the desired extraction media type:

Use the Skip parameter to cancel extraction of this file and proceed to the next one.

DecryptionPasswordNeeded Event (ArchiveReader Class)

Requests a decryption password, when needed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ARCHIVEREADER_DECRYPTIONPASSWORDNEEDED 3

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

class ArchiveReaderDecryptionPasswordNeededEventParams {
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(ArchiveReaderDecryptionPasswordNeededEventParams *e);

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

Remarks

Class fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives.

Inside the event handler, please assign the correct password to DecryptionPassword property, or set Cancel parameter to true to terminate the processing.

Error Event (ArchiveReader Class)

Reports information about errors during archive processing.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ARCHIVEREADER_ERROR 4

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

class ArchiveReaderErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Notification Event (ArchiveReader Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ARCHIVEREADER_NOTIFICATION 5

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

class ArchiveReaderNotificationEventParams {
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(ArchiveReaderNotificationEventParams *e);

// Or, subclass ArchiveReader and override this emitter function.
virtual int FireNotification(ArchiveReaderNotificationEventParams *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.

Progress Event (ArchiveReader Class)

Reports the progress of data extraction.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_ARCHIVEREADER_PROGRESS 6

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

class ArchiveReaderProgressEventParams {
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(ArchiveReaderProgressEventParams *e);

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

Remarks

Subscribe to this event to be notified about decompression progress.

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

RecipientFound Event (ArchiveReader Class)

Informs the application that an archive is encrypted with a digital certificate.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *RecipientHash;
  int lenRecipientHash;
  int CertFound;
  int reserved;
} ArchiveReaderRecipientFoundEventParams;


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

typedef struct {
  LPCSTR RecipientHash;
  INT lenRecipientHash;
  BOOL CertFound;
  INT reserved;
} ArchiveReaderRecipientFoundEventParams;

#define EID_ARCHIVEREADER_RECIPIENTFOUND 7

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

class ArchiveReaderRecipientFoundEventParams {
public:
  const QByteArray &RecipientHash();

  bool CertFound();

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

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

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

Remarks

The class fires this event when processing archives encrypted with an X.509 certificate. CertFound indicates whether the matching certificate has been found in DecryptionCertificates collection.

This event is an opportunity to add the decryption certificate on a later stage if it was not known at the start of the processing.

SignatureFound Event (ArchiveReader Class)

Signifies the start of signature validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e);

typedef struct {
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int CertFound;
  int ValidateSignature;
  int ValidateChain;
  int reserved;
} ArchiveReaderSignatureFoundEventParams;


Unicode (Windows)
virtual INT FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e);

typedef struct {
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL CertFound;
  BOOL ValidateSignature;
  BOOL ValidateChain;
  INT reserved;
} ArchiveReaderSignatureFoundEventParams;

#define EID_ARCHIVEREADER_SIGNATUREFOUND 8

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);

class ArchiveReaderSignatureFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

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

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

// Or, subclass ArchiveReader and override this emitter function.
virtual int FireSignatureFound(ArchiveReaderSignatureFoundEventParams *e) {...}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The ArchiveReader 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 ArchiveReader 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 (ArchiveReader Class)

ArchiveReader Config Settings

 
 Copy
    Console.WriteLine(reader.Files[i].FileName);
    Console.WriteLine(reader.Config("Attributes[" + i.ToString() + "]"));

    // outputs: 
    //
    // file1.txt
    // unix:-rw-r--r--

Base Config Settings

Trappable Errors (ArchiveReader 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.