PDFEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The PDFEncryptor class encrypts PDF documents.

Syntax

PDFEncryptor

Remarks

PDFEncryptor encrypts PDF documents with passwords or certificates.

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.

DocumentInfoEncryptionAlgorithm Property (PDFEncryptor Class)

The symmetric algorithm used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetDocumentInfoEncryptionAlgorithm();

char* secureblackbox_pdfencryptor_getdocumentinfoencryptionalgorithm(void* lpObj);

QString GetDocumentInfoEncryptionAlgorithm();

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

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

Data Type

String

DocumentInfoEncryptionType Property (PDFEncryptor Class)

The document encryption type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoEncryptionType();

Unicode (Windows)
INT GetDocumentInfoEncryptionType();

PET_NONE(0), 
PET_PASSWORD(1), 
PET_CERTIFICATE(2)

int secureblackbox_pdfencryptor_getdocumentinfoencryptiontype(void* lpObj);

int GetDocumentInfoEncryptionType();

Default Value

1

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (PDFEncryptor Class)

Indicates if the document metadata is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoMetadataEncrypted();

Unicode (Windows)
BOOL GetDocumentInfoMetadataEncrypted();

int secureblackbox_pdfencryptor_getdocumentinfometadataencrypted(void* lpObj);

bool GetDocumentInfoMetadataEncrypted();

Default Value

TRUE

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

Metadata contains additional information about the document such as its name and author.

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

Data Type

Boolean

DocumentInfoPermissions Property (PDFEncryptor Class)

Contains the document permissions associated with the encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentInfoPermissions();

Unicode (Windows)
INT GetDocumentInfoPermissions();

int secureblackbox_pdfencryptor_getdocumentinfopermissions(void* lpObj);

int GetDocumentInfoPermissions();

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

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

Data Type

Integer

EncryptionAlgorithm Property (PDFEncryptor Class)

The encryption algorithm to encrypt the document with.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_pdfencryptor_getencryptionalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

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

Default Value

"AES256"

Remarks

Use this property to specify the encryption algorithm to encrypt the PDF document with.

Supported values:

Data Type

String

EncryptionCertificateBytes Property (PDFEncryptor Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateBytes(char* &lpEncryptionCertificateBytes, int &lenEncryptionCertificateBytes);

Unicode (Windows)
INT GetEncryptionCertificateBytes(LPSTR &lpEncryptionCertificateBytes, INT &lenEncryptionCertificateBytes);

int secureblackbox_pdfencryptor_getencryptioncertificatebytes(void* lpObj, char** lpEncryptionCertificateBytes, int* lenEncryptionCertificateBytes);

QByteArray GetEncryptionCertificateBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertificateCA Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateCA();
int SetEncryptionCertificateCA(int bEncryptionCertificateCA);

Unicode (Windows)
BOOL GetEncryptionCertificateCA();
INT SetEncryptionCertificateCA(BOOL bEncryptionCertificateCA);

int secureblackbox_pdfencryptor_getencryptioncertificateca(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateca(void* lpObj, int bEncryptionCertificateCA);

bool GetEncryptionCertificateCA();
int SetEncryptionCertificateCA(bool bEncryptionCertificateCA);

Default Value

FALSE

Remarks

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

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateCAKeyID Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateCAKeyID(char* &lpEncryptionCertificateCAKeyID, int &lenEncryptionCertificateCAKeyID);

Unicode (Windows)
INT GetEncryptionCertificateCAKeyID(LPSTR &lpEncryptionCertificateCAKeyID, INT &lenEncryptionCertificateCAKeyID);

int secureblackbox_pdfencryptor_getencryptioncertificatecakeyid(void* lpObj, char** lpEncryptionCertificateCAKeyID, int* lenEncryptionCertificateCAKeyID);

QByteArray GetEncryptionCertificateCAKeyID();

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

EncryptionCertificateCRLDistributionPoints Property (PDFEncryptor 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* GetEncryptionCertificateCRLDistributionPoints();
int SetEncryptionCertificateCRLDistributionPoints(const char* lpszEncryptionCertificateCRLDistributionPoints);

Unicode (Windows)
LPWSTR GetEncryptionCertificateCRLDistributionPoints();
INT SetEncryptionCertificateCRLDistributionPoints(LPCWSTR lpszEncryptionCertificateCRLDistributionPoints);

char* secureblackbox_pdfencryptor_getencryptioncertificatecrldistributionpoints(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatecrldistributionpoints(void* lpObj, const char* lpszEncryptionCertificateCRLDistributionPoints);

QString GetEncryptionCertificateCRLDistributionPoints();
int SetEncryptionCertificateCRLDistributionPoints(QString qsEncryptionCertificateCRLDistributionPoints);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateCurve Property (PDFEncryptor Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateCurve();
int SetEncryptionCertificateCurve(const char* lpszEncryptionCertificateCurve);

Unicode (Windows)
LPWSTR GetEncryptionCertificateCurve();
INT SetEncryptionCertificateCurve(LPCWSTR lpszEncryptionCertificateCurve);

char* secureblackbox_pdfencryptor_getencryptioncertificatecurve(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatecurve(void* lpObj, const char* lpszEncryptionCertificateCurve);

QString GetEncryptionCertificateCurve();
int SetEncryptionCertificateCurve(QString qsEncryptionCertificateCurve);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

This property is not available at design time.

Data Type

String

EncryptionCertificateFingerprint Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateFingerprint(char* &lpEncryptionCertificateFingerprint, int &lenEncryptionCertificateFingerprint);

Unicode (Windows)
INT GetEncryptionCertificateFingerprint(LPSTR &lpEncryptionCertificateFingerprint, INT &lenEncryptionCertificateFingerprint);

int secureblackbox_pdfencryptor_getencryptioncertificatefingerprint(void* lpObj, char** lpEncryptionCertificateFingerprint, int* lenEncryptionCertificateFingerprint);

QByteArray GetEncryptionCertificateFingerprint();

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

EncryptionCertificateFriendlyName Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateFriendlyName();

Unicode (Windows)
LPWSTR GetEncryptionCertificateFriendlyName();

char* secureblackbox_pdfencryptor_getencryptioncertificatefriendlyname(void* lpObj);

QString GetEncryptionCertificateFriendlyName();

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

EncryptionCertificateHandle Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetEncryptionCertificateHandle();
int SetEncryptionCertificateHandle(int64 lEncryptionCertificateHandle);

Unicode (Windows)
LONG64 GetEncryptionCertificateHandle();
INT SetEncryptionCertificateHandle(LONG64 lEncryptionCertificateHandle);

int64 secureblackbox_pdfencryptor_getencryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatehandle(void* lpObj, int64 lEncryptionCertificateHandle);

qint64 GetEncryptionCertificateHandle();
int SetEncryptionCertificateHandle(qint64 lEncryptionCertificateHandle);

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 not available at design time.

Data Type

Long64

EncryptionCertificateHashAlgorithm Property (PDFEncryptor 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* GetEncryptionCertificateHashAlgorithm();
int SetEncryptionCertificateHashAlgorithm(const char* lpszEncryptionCertificateHashAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionCertificateHashAlgorithm();
INT SetEncryptionCertificateHashAlgorithm(LPCWSTR lpszEncryptionCertificateHashAlgorithm);

char* secureblackbox_pdfencryptor_getencryptioncertificatehashalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatehashalgorithm(void* lpObj, const char* lpszEncryptionCertificateHashAlgorithm);

QString GetEncryptionCertificateHashAlgorithm();
int SetEncryptionCertificateHashAlgorithm(QString qsEncryptionCertificateHashAlgorithm);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateIssuer Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateIssuer();

Unicode (Windows)
LPWSTR GetEncryptionCertificateIssuer();

char* secureblackbox_pdfencryptor_getencryptioncertificateissuer(void* lpObj);

QString GetEncryptionCertificateIssuer();

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

EncryptionCertificateIssuerRDN Property (PDFEncryptor 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* GetEncryptionCertificateIssuerRDN();
int SetEncryptionCertificateIssuerRDN(const char* lpszEncryptionCertificateIssuerRDN);

Unicode (Windows)
LPWSTR GetEncryptionCertificateIssuerRDN();
INT SetEncryptionCertificateIssuerRDN(LPCWSTR lpszEncryptionCertificateIssuerRDN);

char* secureblackbox_pdfencryptor_getencryptioncertificateissuerrdn(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateissuerrdn(void* lpObj, const char* lpszEncryptionCertificateIssuerRDN);

QString GetEncryptionCertificateIssuerRDN();
int SetEncryptionCertificateIssuerRDN(QString qsEncryptionCertificateIssuerRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyAlgorithm Property (PDFEncryptor Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateKeyAlgorithm();
int SetEncryptionCertificateKeyAlgorithm(const char* lpszEncryptionCertificateKeyAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionCertificateKeyAlgorithm();
INT SetEncryptionCertificateKeyAlgorithm(LPCWSTR lpszEncryptionCertificateKeyAlgorithm);

char* secureblackbox_pdfencryptor_getencryptioncertificatekeyalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatekeyalgorithm(void* lpObj, const char* lpszEncryptionCertificateKeyAlgorithm);

QString GetEncryptionCertificateKeyAlgorithm();
int SetEncryptionCertificateKeyAlgorithm(QString qsEncryptionCertificateKeyAlgorithm);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyBits Property (PDFEncryptor Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateKeyBits();

Unicode (Windows)
INT GetEncryptionCertificateKeyBits();

int secureblackbox_pdfencryptor_getencryptioncertificatekeybits(void* lpObj);

int GetEncryptionCertificateKeyBits();

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

EncryptionCertificateKeyFingerprint Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateKeyFingerprint(char* &lpEncryptionCertificateKeyFingerprint, int &lenEncryptionCertificateKeyFingerprint);

Unicode (Windows)
INT GetEncryptionCertificateKeyFingerprint(LPSTR &lpEncryptionCertificateKeyFingerprint, INT &lenEncryptionCertificateKeyFingerprint);

int secureblackbox_pdfencryptor_getencryptioncertificatekeyfingerprint(void* lpObj, char** lpEncryptionCertificateKeyFingerprint, int* lenEncryptionCertificateKeyFingerprint);

QByteArray GetEncryptionCertificateKeyFingerprint();

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

EncryptionCertificateKeyUsage Property (PDFEncryptor 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 GetEncryptionCertificateKeyUsage();
int SetEncryptionCertificateKeyUsage(int iEncryptionCertificateKeyUsage);

Unicode (Windows)
INT GetEncryptionCertificateKeyUsage();
INT SetEncryptionCertificateKeyUsage(INT iEncryptionCertificateKeyUsage);

int secureblackbox_pdfencryptor_getencryptioncertificatekeyusage(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatekeyusage(void* lpObj, int iEncryptionCertificateKeyUsage);

int GetEncryptionCertificateKeyUsage();
int SetEncryptionCertificateKeyUsage(int iEncryptionCertificateKeyUsage);

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 not available at design time.

Data Type

Integer

EncryptionCertificateKeyValid Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateKeyValid();

Unicode (Windows)
BOOL GetEncryptionCertificateKeyValid();

int secureblackbox_pdfencryptor_getencryptioncertificatekeyvalid(void* lpObj);

bool GetEncryptionCertificateKeyValid();

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

EncryptionCertificateOCSPLocations Property (PDFEncryptor 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* GetEncryptionCertificateOCSPLocations();
int SetEncryptionCertificateOCSPLocations(const char* lpszEncryptionCertificateOCSPLocations);

Unicode (Windows)
LPWSTR GetEncryptionCertificateOCSPLocations();
INT SetEncryptionCertificateOCSPLocations(LPCWSTR lpszEncryptionCertificateOCSPLocations);

char* secureblackbox_pdfencryptor_getencryptioncertificateocsplocations(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateocsplocations(void* lpObj, const char* lpszEncryptionCertificateOCSPLocations);

QString GetEncryptionCertificateOCSPLocations();
int SetEncryptionCertificateOCSPLocations(QString qsEncryptionCertificateOCSPLocations);

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 not available at design time.

Data Type

String

EncryptionCertificateOCSPNoCheck Property (PDFEncryptor Class)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateOCSPNoCheck();
int SetEncryptionCertificateOCSPNoCheck(int bEncryptionCertificateOCSPNoCheck);

Unicode (Windows)
BOOL GetEncryptionCertificateOCSPNoCheck();
INT SetEncryptionCertificateOCSPNoCheck(BOOL bEncryptionCertificateOCSPNoCheck);

int secureblackbox_pdfencryptor_getencryptioncertificateocspnocheck(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateocspnocheck(void* lpObj, int bEncryptionCertificateOCSPNoCheck);

bool GetEncryptionCertificateOCSPNoCheck();
int SetEncryptionCertificateOCSPNoCheck(bool bEncryptionCertificateOCSPNoCheck);

Default Value

FALSE

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateOrigin Property (PDFEncryptor Class)

Returns the origin of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateOrigin();

Unicode (Windows)
INT GetEncryptionCertificateOrigin();

int secureblackbox_pdfencryptor_getencryptioncertificateorigin(void* lpObj);

int GetEncryptionCertificateOrigin();

Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

EncryptionCertificatePolicyIDs Property (PDFEncryptor Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificatePolicyIDs();
int SetEncryptionCertificatePolicyIDs(const char* lpszEncryptionCertificatePolicyIDs);

Unicode (Windows)
LPWSTR GetEncryptionCertificatePolicyIDs();
INT SetEncryptionCertificatePolicyIDs(LPCWSTR lpszEncryptionCertificatePolicyIDs);

char* secureblackbox_pdfencryptor_getencryptioncertificatepolicyids(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatepolicyids(void* lpObj, const char* lpszEncryptionCertificatePolicyIDs);

QString GetEncryptionCertificatePolicyIDs();
int SetEncryptionCertificatePolicyIDs(QString qsEncryptionCertificatePolicyIDs);

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 not available at design time.

Data Type

String

EncryptionCertificatePrivateKeyBytes Property (PDFEncryptor Class)

Contains the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificatePrivateKeyBytes(char* &lpEncryptionCertificatePrivateKeyBytes, int &lenEncryptionCertificatePrivateKeyBytes);

Unicode (Windows)
INT GetEncryptionCertificatePrivateKeyBytes(LPSTR &lpEncryptionCertificatePrivateKeyBytes, INT &lenEncryptionCertificatePrivateKeyBytes);

int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeybytes(void* lpObj, char** lpEncryptionCertificatePrivateKeyBytes, int* lenEncryptionCertificatePrivateKeyBytes);

QByteArray GetEncryptionCertificatePrivateKeyBytes();

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

EncryptionCertificatePrivateKeyExists Property (PDFEncryptor Class)

Indicates whether the certificate has an associated private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificatePrivateKeyExists();

Unicode (Windows)
BOOL GetEncryptionCertificatePrivateKeyExists();

int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeyexists(void* lpObj);

bool GetEncryptionCertificatePrivateKeyExists();

Default Value

FALSE

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

EncryptionCertificatePrivateKeyExtractable Property (PDFEncryptor Class)

Indicates whether the private key is extractable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificatePrivateKeyExtractable();

Unicode (Windows)
BOOL GetEncryptionCertificatePrivateKeyExtractable();

int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeyextractable(void* lpObj);

bool GetEncryptionCertificatePrivateKeyExtractable();

Default Value

FALSE

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

EncryptionCertificatePublicKeyBytes Property (PDFEncryptor Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificatePublicKeyBytes(char* &lpEncryptionCertificatePublicKeyBytes, int &lenEncryptionCertificatePublicKeyBytes);

Unicode (Windows)
INT GetEncryptionCertificatePublicKeyBytes(LPSTR &lpEncryptionCertificatePublicKeyBytes, INT &lenEncryptionCertificatePublicKeyBytes);

int secureblackbox_pdfencryptor_getencryptioncertificatepublickeybytes(void* lpObj, char** lpEncryptionCertificatePublicKeyBytes, int* lenEncryptionCertificatePublicKeyBytes);

QByteArray GetEncryptionCertificatePublicKeyBytes();

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

EncryptionCertificateQualifiedStatements Property (PDFEncryptor Class)

Returns the qualified status of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateQualifiedStatements();
int SetEncryptionCertificateQualifiedStatements(int iEncryptionCertificateQualifiedStatements);

Unicode (Windows)
INT GetEncryptionCertificateQualifiedStatements();
INT SetEncryptionCertificateQualifiedStatements(INT iEncryptionCertificateQualifiedStatements);

QST_NON_QUALIFIED(0), 
QST_QUALIFIED_HARDWARE(1), 
QST_QUALIFIED_SOFTWARE(2)

int secureblackbox_pdfencryptor_getencryptioncertificatequalifiedstatements(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatequalifiedstatements(void* lpObj, int iEncryptionCertificateQualifiedStatements);

int GetEncryptionCertificateQualifiedStatements();
int SetEncryptionCertificateQualifiedStatements(int iEncryptionCertificateQualifiedStatements);

Default Value

0

Remarks

Returns the qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

EncryptionCertificateSelfSigned Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateSelfSigned();

Unicode (Windows)
BOOL GetEncryptionCertificateSelfSigned();

int secureblackbox_pdfencryptor_getencryptioncertificateselfsigned(void* lpObj);

bool GetEncryptionCertificateSelfSigned();

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

EncryptionCertificateSerialNumber Property (PDFEncryptor Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateSerialNumber(char* &lpEncryptionCertificateSerialNumber, int &lenEncryptionCertificateSerialNumber);
int SetEncryptionCertificateSerialNumber(const char* lpEncryptionCertificateSerialNumber, int lenEncryptionCertificateSerialNumber);

Unicode (Windows)
INT GetEncryptionCertificateSerialNumber(LPSTR &lpEncryptionCertificateSerialNumber, INT &lenEncryptionCertificateSerialNumber);
INT SetEncryptionCertificateSerialNumber(LPCSTR lpEncryptionCertificateSerialNumber, INT lenEncryptionCertificateSerialNumber);

int secureblackbox_pdfencryptor_getencryptioncertificateserialnumber(void* lpObj, char** lpEncryptionCertificateSerialNumber, int* lenEncryptionCertificateSerialNumber);
int secureblackbox_pdfencryptor_setencryptioncertificateserialnumber(void* lpObj, const char* lpEncryptionCertificateSerialNumber, int lenEncryptionCertificateSerialNumber);

QByteArray GetEncryptionCertificateSerialNumber();
int SetEncryptionCertificateSerialNumber(QByteArray qbaEncryptionCertificateSerialNumber);

Remarks

Returns the certificate's serial number.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSigAlgorithm Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateSigAlgorithm();

Unicode (Windows)
LPWSTR GetEncryptionCertificateSigAlgorithm();

char* secureblackbox_pdfencryptor_getencryptioncertificatesigalgorithm(void* lpObj);

QString GetEncryptionCertificateSigAlgorithm();

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

EncryptionCertificateSubject Property (PDFEncryptor 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* GetEncryptionCertificateSubject();

Unicode (Windows)
LPWSTR GetEncryptionCertificateSubject();

char* secureblackbox_pdfencryptor_getencryptioncertificatesubject(void* lpObj);

QString GetEncryptionCertificateSubject();

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

EncryptionCertificateSubjectAlternativeName Property (PDFEncryptor Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateSubjectAlternativeName();
int SetEncryptionCertificateSubjectAlternativeName(const char* lpszEncryptionCertificateSubjectAlternativeName);

Unicode (Windows)
LPWSTR GetEncryptionCertificateSubjectAlternativeName();
INT SetEncryptionCertificateSubjectAlternativeName(LPCWSTR lpszEncryptionCertificateSubjectAlternativeName);

char* secureblackbox_pdfencryptor_getencryptioncertificatesubjectalternativename(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectalternativename(void* lpObj, const char* lpszEncryptionCertificateSubjectAlternativeName);

QString GetEncryptionCertificateSubjectAlternativeName();
int SetEncryptionCertificateSubjectAlternativeName(QString qsEncryptionCertificateSubjectAlternativeName);

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

This property is not available at design time.

Data Type

String

EncryptionCertificateSubjectKeyID Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionCertificateSubjectKeyID(char* &lpEncryptionCertificateSubjectKeyID, int &lenEncryptionCertificateSubjectKeyID);
int SetEncryptionCertificateSubjectKeyID(const char* lpEncryptionCertificateSubjectKeyID, int lenEncryptionCertificateSubjectKeyID);

Unicode (Windows)
INT GetEncryptionCertificateSubjectKeyID(LPSTR &lpEncryptionCertificateSubjectKeyID, INT &lenEncryptionCertificateSubjectKeyID);
INT SetEncryptionCertificateSubjectKeyID(LPCSTR lpEncryptionCertificateSubjectKeyID, INT lenEncryptionCertificateSubjectKeyID);

int secureblackbox_pdfencryptor_getencryptioncertificatesubjectkeyid(void* lpObj, char** lpEncryptionCertificateSubjectKeyID, int* lenEncryptionCertificateSubjectKeyID);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectkeyid(void* lpObj, const char* lpEncryptionCertificateSubjectKeyID, int lenEncryptionCertificateSubjectKeyID);

QByteArray GetEncryptionCertificateSubjectKeyID();
int SetEncryptionCertificateSubjectKeyID(QByteArray qbaEncryptionCertificateSubjectKeyID);

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 not available at design time.

Data Type

Byte Array

EncryptionCertificateSubjectRDN Property (PDFEncryptor 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* GetEncryptionCertificateSubjectRDN();
int SetEncryptionCertificateSubjectRDN(const char* lpszEncryptionCertificateSubjectRDN);

Unicode (Windows)
LPWSTR GetEncryptionCertificateSubjectRDN();
INT SetEncryptionCertificateSubjectRDN(LPCWSTR lpszEncryptionCertificateSubjectRDN);

char* secureblackbox_pdfencryptor_getencryptioncertificatesubjectrdn(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectrdn(void* lpObj, const char* lpszEncryptionCertificateSubjectRDN);

QString GetEncryptionCertificateSubjectRDN();
int SetEncryptionCertificateSubjectRDN(QString qsEncryptionCertificateSubjectRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateValidFrom Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateValidFrom();
int SetEncryptionCertificateValidFrom(const char* lpszEncryptionCertificateValidFrom);

Unicode (Windows)
LPWSTR GetEncryptionCertificateValidFrom();
INT SetEncryptionCertificateValidFrom(LPCWSTR lpszEncryptionCertificateValidFrom);

char* secureblackbox_pdfencryptor_getencryptioncertificatevalidfrom(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatevalidfrom(void* lpObj, const char* lpszEncryptionCertificateValidFrom);

QString GetEncryptionCertificateValidFrom();
int SetEncryptionCertificateValidFrom(QString qsEncryptionCertificateValidFrom);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateValidTo Property (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionCertificateValidTo();
int SetEncryptionCertificateValidTo(const char* lpszEncryptionCertificateValidTo);

Unicode (Windows)
LPWSTR GetEncryptionCertificateValidTo();
INT SetEncryptionCertificateValidTo(LPCWSTR lpszEncryptionCertificateValidTo);

char* secureblackbox_pdfencryptor_getencryptioncertificatevalidto(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatevalidto(void* lpObj, const char* lpszEncryptionCertificateValidTo);

QString GetEncryptionCertificateValidTo();
int SetEncryptionCertificateValidTo(QString qsEncryptionCertificateValidTo);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptMetadata Property (PDFEncryptor Class)

Specifies whether to encrypt the document metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptMetadata();
int SetEncryptMetadata(int bEncryptMetadata);

Unicode (Windows)
BOOL GetEncryptMetadata();
INT SetEncryptMetadata(BOOL bEncryptMetadata);

int secureblackbox_pdfencryptor_getencryptmetadata(void* lpObj);
int secureblackbox_pdfencryptor_setencryptmetadata(void* lpObj, int bEncryptMetadata);

bool GetEncryptMetadata();
int SetEncryptMetadata(bool bEncryptMetadata);

Default Value

TRUE

Remarks

Use this property to enable or disable metadata encryption.

Metadata contains additional information about the document, such as its name and author.

Data Type

Boolean

FIPSMode Property (PDFEncryptor 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_pdfencryptor_getfipsmode(void* lpObj);
int secureblackbox_pdfencryptor_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

InputBytes Property (PDFEncryptor Class)

Use this property to pass the input to class in byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_pdfencryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pdfencryptor_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFEncryptor Class)

The PDF file to be encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_pdfencryptor_getinputfile(void* lpObj);
int secureblackbox_pdfencryptor_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Provide the path to the PDF document to be encrypted.

Data Type

String

OutputBytes Property (PDFEncryptor Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_pdfencryptor_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (PDFEncryptor Class)

The file to save the encrypted document to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_pdfencryptor_getoutputfile(void* lpObj);
int secureblackbox_pdfencryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Specifies the path where the encrypted PDF should be saved.

Data Type

String

OwnerPassword Property (PDFEncryptor Class)

The owner password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOwnerPassword();
int SetOwnerPassword(const char* lpszOwnerPassword);

Unicode (Windows)
LPWSTR GetOwnerPassword();
INT SetOwnerPassword(LPCWSTR lpszOwnerPassword);

char* secureblackbox_pdfencryptor_getownerpassword(void* lpObj);
int secureblackbox_pdfencryptor_setownerpassword(void* lpObj, const char* lpszOwnerPassword);

QString GetOwnerPassword();
int SetOwnerPassword(QString qsOwnerPassword);

Default Value

""

Remarks

Use this property to provide the document owner password. Though it may be different from UserPassword, most implementations use the same value for both.

Data Type

String

Permissions Property (PDFEncryptor Class)

Specifies the document permissions associated with the encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissions();
int SetPermissions(int iPermissions);

Unicode (Windows)
INT GetPermissions();
INT SetPermissions(INT iPermissions);

int secureblackbox_pdfencryptor_getpermissions(void* lpObj);
int secureblackbox_pdfencryptor_setpermissions(void* lpObj, int iPermissions);

int GetPermissions();
int SetPermissions(int iPermissions);

Default Value

0

Remarks

Use this property to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but keep in mind that it is a policy-like requirement rather than an enforcement. Provide the permissions as a bit mask of the following flags:

This property is not available at design time.

Data Type

Integer

UserPassword Property (PDFEncryptor Class)

The user password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserPassword();
int SetUserPassword(const char* lpszUserPassword);

Unicode (Windows)
LPWSTR GetUserPassword();
INT SetUserPassword(LPCWSTR lpszUserPassword);

char* secureblackbox_pdfencryptor_getuserpassword(void* lpObj);
int secureblackbox_pdfencryptor_setuserpassword(void* lpObj, const char* lpszUserPassword);

QString GetUserPassword();
int SetUserPassword(QString qsUserPassword);

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

Config Method (PDFEncryptor 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_pdfencryptor_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 (PDFEncryptor 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_pdfencryptor_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.

Encrypt Method (PDFEncryptor Class)

Encrypts the PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int secureblackbox_pdfencryptor_encrypt(void* lpObj);

int Encrypt();

Remarks

Use this method to encrypt the PDF document as configured in the object's 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.)

DocumentLoaded Event (PDFEncryptor Class)

This event is fired when the document has been loaded into memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e);

typedef struct {
  int Cancel;
  int reserved;
} PDFEncryptorDocumentLoadedEventParams;


Unicode (Windows)
virtual INT FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e);

typedef struct {
  BOOL Cancel;
  INT reserved;
} PDFEncryptorDocumentLoadedEventParams;

#define EID_PDFENCRYPTOR_DOCUMENTLOADED 1

virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);

class PDFEncryptorDocumentLoadedEventParams {
public:
  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass PDFEncryptor and override this emitter function.
virtual int FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e) {...}

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the Pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

Error Event (PDFEncryptor Class)

Information about errors during encryption.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PDFENCRYPTOR_ERROR 2

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

class PDFEncryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Notification Event (PDFEncryptor Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PDFENCRYPTOR_NOTIFICATION 3

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

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

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

Config Settings (PDFEncryptor Class)

PDFEncryptor Config Settings

Base Config Settings

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

PDFEncryptor Errors