#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

Macros
#define	PDFTOOLS_CALL

#define	PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleA

#define	PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleA

#define	PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorA

#define	PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorA

#define	PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectA

#define	PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectA

#define	PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsA

#define	PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsA

#define	PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorA

#define	PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorA

#define	PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerA

#define	PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerA

#define	PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewA

#define	PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsA

#define	PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordA

#define	PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordA

#define	PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordA

#define	PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenA

#define	PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleA

#define	PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorA

#define	PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectA

#define	PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsA

#define	PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorA

#define	PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerA

#define	PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameA

#define	PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameA

#define	PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationA

#define	PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonA

#define	PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoA

Functions
PDFTOOLS_EXPORT TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_New (void)

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetTitleA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetTitleW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetTitleA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szTitle)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetTitleW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szTitle)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetAuthorA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetAuthorW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetAuthorA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szAuthor)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetAuthorW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szAuthor)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetSubjectA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetSubjectW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetSubjectA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szSubject)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetSubjectW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szSubject)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetKeywordsA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetKeywordsW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetKeywordsA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szKeywords)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetKeywordsW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szKeywords)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetCreatorA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	The original application that created the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetCreatorW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	The original application that created the document.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetCreatorA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szCreator)
	The original application that created the document.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetCreatorW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szCreator)
	The original application that created the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetProducerA (TPdfToolsPdf_MetadataSettings pMetadataSettings, char pBuffer, size_t nBufferSize)
	The application that created the PDF.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetProducerW (TPdfToolsPdf_MetadataSettings pMetadataSettings, WCHAR pBuffer, size_t nBufferSize)
	The application that created the PDF.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetProducerA (TPdfToolsPdf_MetadataSettings pMetadataSettings, const char szProducer)
	The application that created the PDF.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetProducerW (TPdfToolsPdf_MetadataSettings pMetadataSettings, const WCHAR szProducer)
	The application that created the PDF.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetCreationDate (TPdfToolsPdf_MetadataSettings pMetadataSettings, TPdfToolsSys_Date pCreationDate)
	The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetCreationDate (TPdfToolsPdf_MetadataSettings pMetadataSettings, const TPdfToolsSys_Date pCreationDate)
	The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_GetModificationDate (TPdfToolsPdf_MetadataSettings pMetadataSettings, TPdfToolsSys_Date pModificationDate)
	The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_MetadataSettings_SetModificationDate (TPdfToolsPdf_MetadataSettings pMetadataSettings, const TPdfToolsSys_Date pModificationDate)
	The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL	PdfToolsPdf_Encryption_NewA (const char szUserPassword, const char szOwnerPassword, TPdfToolsPdf_Permission iPermissions)

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL	PdfToolsPdf_Encryption_NewW (const WCHAR szUserPassword, const WCHAR szOwnerPassword, TPdfToolsPdf_Permission iPermissions)

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Encryption_SetPermissionsA (TPdfToolsPdf_Encryption pEncryption, const char szOwnerPassword, TPdfToolsPdf_Permission iPermissions)
	Set the owner password and access permissions. Only the given permissions are granted when opening the document. To the owner of the document, all permissions are granted. For this, the document must be opened by specifying the owner password (see PdfToolsPdf_Encryption_GetOwnerPassword).

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Encryption_SetPermissionsW (TPdfToolsPdf_Encryption pEncryption, const WCHAR szOwnerPassword, TPdfToolsPdf_Permission iPermissions)
	Set the owner password and access permissions. Only the given permissions are granted when opening the document. To the owner of the document, all permissions are granted. For this, the document must be opened by specifying the owner password (see PdfToolsPdf_Encryption_GetOwnerPassword).

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Encryption_GetUserPasswordA (TPdfToolsPdf_Encryption pEncryption, char pBuffer, size_t nBufferSize)
	The user password.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Encryption_GetUserPasswordW (TPdfToolsPdf_Encryption pEncryption, WCHAR pBuffer, size_t nBufferSize)
	The user password.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Encryption_SetUserPasswordA (TPdfToolsPdf_Encryption pEncryption, const char szUserPassword)
	The user password.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Encryption_SetUserPasswordW (TPdfToolsPdf_Encryption pEncryption, const WCHAR szUserPassword)
	The user password.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Encryption_GetOwnerPasswordA (TPdfToolsPdf_Encryption pEncryption, char pBuffer, size_t nBufferSize)
	The owner password.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Encryption_GetOwnerPasswordW (TPdfToolsPdf_Encryption pEncryption, WCHAR pBuffer, size_t nBufferSize)
	The owner password.

PDFTOOLS_EXPORT TPdfToolsPdf_Permission PDFTOOLS_CALL	PdfToolsPdf_Encryption_GetPermissions (TPdfToolsPdf_Encryption *pEncryption)
	The access permissions granted when opening the document.

PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptions *PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_New (void)

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_GetEncryption (TPdfToolsPdf_OutputOptions *pOutputOptions)
	The parameters to encrypt output PDFs.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_SetEncryption (TPdfToolsPdf_OutputOptions pOutputOptions, TPdfToolsPdf_Encryption pEncryption)
	The parameters to encrypt output PDFs.

PDFTOOLS_EXPORT TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_GetMetadataSettings (TPdfToolsPdf_OutputOptions *pOutputOptions)

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_SetMetadataSettings (TPdfToolsPdf_OutputOptions pOutputOptions, TPdfToolsPdf_MetadataSettings pMetadataSettings)

PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptionsType PDFTOOLS_CALL	PdfToolsPdf_OutputOptions_GetType (TPdfToolsPdf_OutputOptions *pOutputOptions)
	Get actual derived type of base type TPdfToolsPdf_OutputOptions.

PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL	PdfToolsPdf_Document_OpenA (const TPdfToolsSys_StreamDescriptor pStreamDesc, const char szPassword)
	Open a PDF document. Documents opened with this method are read-only and cannot be modified.

PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL	PdfToolsPdf_Document_OpenW (const TPdfToolsSys_StreamDescriptor pStreamDesc, const WCHAR szPassword)
	Open a PDF document. Documents opened with this method are read-only and cannot be modified.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Document_GetConformance (TPdfToolsPdf_Document pDocument, TPdfToolsPdf_Conformance pConformance)
	The claimed conformance of the document.

PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsPdf_Document_GetPageCount (TPdfToolsPdf_Document *pDocument)
	The number of pages in the document If the document is a collection (also known as PDF Portfolio), then this property is `0`.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Document_GetPermissions (TPdfToolsPdf_Document pDocument, TPdfToolsPdf_Permission pPermissions)
	The access permissions applicable for this document.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Document_IsLinearized (TPdfToolsPdf_Document *pDocument)
	Whether the document is linearized.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Document_IsSigned (TPdfToolsPdf_Document *pDocument)

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldList *PDFTOOLS_CALL	PdfToolsPdf_Document_GetSignatureFields (TPdfToolsPdf_Document *pDocument)

PDFTOOLS_EXPORT TPdfToolsPdf_XfaType PDFTOOLS_CALL	PdfToolsPdf_Document_GetXfa (TPdfToolsPdf_Document *pDocument)
	Whether the document is an XML Forms Architecture (XFA) or a PDF document While XFA documents may seem like regular PDF documents they are not and cannot be processed by many components (error ePdfTools_Error_UnsupportedFeature). An XFA form is included as a resource in a mere shell PDF. The PDF pages' content is generated dynamically from the XFA data, which is a complex, non-standardized process. For this reason, XFA is forbidden by the ISO Standards ISO 19'005-2 (PDF/A-2) and ISO 32'000-2 (PDF 2.0) and newer. It is recommended to convert XFA documents to PDF using an Adobe product, e.g. by using the "Print to PDF" function of Adobe Acrobat Reader.

PDFTOOLS_EXPORT TPdfToolsPdf_Metadata *PDFTOOLS_CALL	PdfToolsPdf_Document_GetMetadata (TPdfToolsPdf_Document *pDocument)
	The metadata of the document.

PDFTOOLS_EXPORT TPdfToolsPdf_DocumentType PDFTOOLS_CALL	PdfToolsPdf_Document_GetType (TPdfToolsPdf_Document *pDocument)
	Get actual derived type of base type TPdfToolsPdf_Document.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Document_Close (TPdfToolsPdf_Document *pObject)
	Close object.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetTitleA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetTitleW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetAuthorA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetAuthorW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetSubjectA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetSubjectW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetKeywordsA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetKeywordsW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	Keywords associated with the document or resource.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetCreatorA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	The original application that created the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetCreatorW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	The original application that created the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetProducerA (TPdfToolsPdf_Metadata pMetadata, char pBuffer, size_t nBufferSize)
	The application that created the PDF.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetProducerW (TPdfToolsPdf_Metadata pMetadata, WCHAR pBuffer, size_t nBufferSize)
	The application that created the PDF.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetCreationDate (TPdfToolsPdf_Metadata pMetadata, TPdfToolsSys_Date pCreationDate)
	The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Metadata_GetModificationDate (TPdfToolsPdf_Metadata pMetadata, TPdfToolsSys_Date pModificationDate)
	The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_SignatureField_GetFieldNameA (TPdfToolsPdf_SignatureField pSignatureField, char pBuffer, size_t nBufferSize)
	The name of the signature field The field name uniquely identifies the signature field within the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_SignatureField_GetFieldNameW (TPdfToolsPdf_SignatureField pSignatureField, WCHAR pBuffer, size_t nBufferSize)
	The name of the signature field The field name uniquely identifies the signature field within the document.

PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsPdf_SignatureField_GetPageNumber (TPdfToolsPdf_SignatureField *pSignatureField)
	The number of the page where this signature is located Whether the signature field has a visual appearance on that page is indicated by the PdfToolsPdf_SignatureField_GetBoundingBox.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_SignatureField_GetBoundingBox (TPdfToolsPdf_SignatureField pSignatureField, TPdfToolsGeomUnits_Rectangle pBoundingBox)
	The location on the page The location of the signature field on the page. Or `NULL` if the signature field has no visual appearance.

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldType PDFTOOLS_CALL	PdfToolsPdf_SignatureField_GetType (TPdfToolsPdf_SignatureField *pSignatureField)
	Get actual derived type of base type TPdfToolsPdf_SignatureField.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_SignedSignatureField_GetNameA (TPdfToolsPdf_SignedSignatureField pSignedSignatureField, char pBuffer, size_t nBufferSize)
	The name of the person or authority that signed the document.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_SignedSignatureField_GetNameW (TPdfToolsPdf_SignedSignatureField pSignedSignatureField, WCHAR pBuffer, size_t nBufferSize)
	The name of the person or authority that signed the document.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_SignedSignatureField_GetDate (TPdfToolsPdf_SignedSignatureField pSignedSignatureField, TPdfToolsSys_Date pDate)
	The date and time of signing.

PDFTOOLS_EXPORT TPdfToolsPdf_Revision *PDFTOOLS_CALL	PdfToolsPdf_SignedSignatureField_GetRevision (TPdfToolsPdf_SignedSignatureField *pSignedSignatureField)
	The document revision The revision (version) of the document that the signature signs.

PDFTOOLS_EXPORT TPdfToolsPdf_SignedSignatureFieldType PDFTOOLS_CALL	PdfToolsPdf_SignedSignatureField_GetType (TPdfToolsPdf_SignedSignatureField *pSignedSignatureField)
	Get actual derived type of base type TPdfToolsPdf_SignedSignatureField.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetLocationA (TPdfToolsPdf_Signature pSignature, char pBuffer, size_t nBufferSize)
	The location of signing The CPU host name or physical location of the signing.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetLocationW (TPdfToolsPdf_Signature pSignature, WCHAR pBuffer, size_t nBufferSize)
	The location of signing The CPU host name or physical location of the signing.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetReasonA (TPdfToolsPdf_Signature pSignature, char pBuffer, size_t nBufferSize)
	The reason for signing.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetReasonW (TPdfToolsPdf_Signature pSignature, WCHAR pBuffer, size_t nBufferSize)
	The reason for signing.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetContactInfoA (TPdfToolsPdf_Signature pSignature, char pBuffer, size_t nBufferSize)
	The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsPdf_Signature_GetContactInfoW (TPdfToolsPdf_Signature pSignature, WCHAR pBuffer, size_t nBufferSize)
	The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureType PDFTOOLS_CALL	PdfToolsPdf_Signature_GetType (TPdfToolsPdf_Signature *pSignature)
	Get actual derived type of base type TPdfToolsPdf_Signature.

PDFTOOLS_EXPORT TPdfToolsPdf_MdpPermissions PDFTOOLS_CALL	PdfToolsPdf_CertificationSignature_GetPermissions (TPdfToolsPdf_CertificationSignature *pCertificationSignature)
	The access permissions granted for this document Note that for encrypted PDF documents, the restrictions defined by this `CertificationSignature` are in addition to the document's PdfToolsPdf_Document_GetPermissions.

PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsPdf_SignatureFieldList_GetCount (TPdfToolsPdf_SignatureFieldList *pSignatureFieldList)
	Get the number of elements in the list.

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureField *PDFTOOLS_CALL	PdfToolsPdf_SignatureFieldList_Get (TPdfToolsPdf_SignatureFieldList *pSignatureFieldList, int iIndex)
	Returns the element at the specified position in the given list.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Revision_Write (TPdfToolsPdf_Revision pRevision, const TPdfToolsSys_StreamDescriptor pStreamDesc)
	Write the contents of the document revision to a stream.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf_Revision_IsLatest (TPdfToolsPdf_Revision *pRevision)
	Whether this is the latest document revision.

PDFTOOLS_EXPORT TPdfToolsPdf_Conformance PDFTOOLS_CALL	PdfToolsPdf_Conformance_ParseW (const WCHAR *szConformanceString)
	Parse conformance string.

PDFTOOLS_EXPORT TPdfToolsPdf_Conformance PDFTOOLS_CALL	PdfToolsPdf_Conformance_ParseA (const char *szConformanceString)
	Parse conformance string.

PDFTOOLS_EXPORT const WCHAR *PDFTOOLS_CALL	PdfToolsPdf_Conformance_ToStringW (TPdfToolsPdf_Conformance iConformance)
	Create string representation of conformance.

PDFTOOLS_EXPORT const char *PDFTOOLS_CALL	PdfToolsPdf_Conformance_ToStringA (TPdfToolsPdf_Conformance iConformance)
	Create string representation of conformance.

Macro Definition Documentation

◆ PDFTOOLS_CALL

#define PDFTOOLS_CALL

◆ PdfToolsPdf_Document_Open

#define PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenA

◆ PdfToolsPdf_Encryption_GetOwnerPassword

#define PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordA

◆ PdfToolsPdf_Encryption_GetUserPassword

#define PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordA

◆ PdfToolsPdf_Encryption_New

#define PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewA

◆ PdfToolsPdf_Encryption_SetPermissions

#define PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsA

◆ PdfToolsPdf_Encryption_SetUserPassword

#define PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordA

◆ PdfToolsPdf_Metadata_GetAuthor

#define PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorA

◆ PdfToolsPdf_Metadata_GetCreator

#define PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorA

◆ PdfToolsPdf_Metadata_GetKeywords

#define PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsA

◆ PdfToolsPdf_Metadata_GetProducer

#define PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerA

◆ PdfToolsPdf_Metadata_GetSubject

#define PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectA

◆ PdfToolsPdf_Metadata_GetTitle

#define PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleA

◆ PdfToolsPdf_MetadataSettings_GetAuthor

#define PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorA

◆ PdfToolsPdf_MetadataSettings_GetCreator

#define PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorA

◆ PdfToolsPdf_MetadataSettings_GetKeywords

#define PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsA

◆ PdfToolsPdf_MetadataSettings_GetProducer

#define PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerA

◆ PdfToolsPdf_MetadataSettings_GetSubject

#define PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectA

◆ PdfToolsPdf_MetadataSettings_GetTitle

#define PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleA

◆ PdfToolsPdf_MetadataSettings_SetAuthor

#define PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorA

◆ PdfToolsPdf_MetadataSettings_SetCreator

#define PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorA

◆ PdfToolsPdf_MetadataSettings_SetKeywords

#define PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsA

◆ PdfToolsPdf_MetadataSettings_SetProducer

#define PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerA

◆ PdfToolsPdf_MetadataSettings_SetSubject

#define PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectA

◆ PdfToolsPdf_MetadataSettings_SetTitle

#define PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleA

◆ PdfToolsPdf_Signature_GetContactInfo

#define PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoA

◆ PdfToolsPdf_Signature_GetLocation

#define PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationA

◆ PdfToolsPdf_Signature_GetReason

#define PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonA

◆ PdfToolsPdf_SignatureField_GetFieldName

#define PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameA

◆ PdfToolsPdf_SignedSignatureField_GetName

#define PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameA

Function Documentation

◆ PdfToolsPdf_CertificationSignature_GetPermissions()

PDFTOOLS_EXPORT TPdfToolsPdf_MdpPermissions PDFTOOLS_CALL PdfToolsPdf_CertificationSignature_GetPermissions ( TPdfToolsPdf_CertificationSignature * pCertificationSignature )

The access permissions granted for this document Note that for encrypted PDF documents, the restrictions defined by this CertificationSignature are in addition to the document's PdfToolsPdf_Document_GetPermissions.

Parameters

[in,out] pCertificationSignature Acts as a handle to the native object of type TPdfToolsPdf_CertificationSignature.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Conformance_ParseA()

PDFTOOLS_EXPORT TPdfToolsPdf_Conformance PDFTOOLS_CALL PdfToolsPdf_Conformance_ParseA ( const char * szConformanceString )

Parse conformance string.

Get conformance enumeration item of type TPdfToolsPdf_Conformance from a string.

Parameters

[in] szConformanceString Conformance as string. Possible values: "PDF 1.0", "PDF 1.1", "PDF 1.2", "PDF 1.3", "PDF 1.4", "PDF 1.5", "PDF 1.6", "PDF 1.7", "PDF 2.0", "PDF/A-1b", "PDF/A-1a", "PDF/A-2b", "PDF/A-2u", "PDF/A-2a", "PDF/A-3b", "PDF/A-3u" and "PDF/A-3a"

Returns: Conformance enumeration item. 0 in case of an error.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsPdf_Conformance_ParseW()

PDFTOOLS_EXPORT TPdfToolsPdf_Conformance PDFTOOLS_CALL PdfToolsPdf_Conformance_ParseW ( const WCHAR * szConformanceString )

Parse conformance string.

Get conformance enumeration item of type TPdfToolsPdf_Conformance from a string.

Parameters

[in] szConformanceString Conformance as string. Possible values: "PDF 1.0", "PDF 1.1", "PDF 1.2", "PDF 1.3", "PDF 1.4", "PDF 1.5", "PDF 1.6", "PDF 1.7", "PDF 2.0", "PDF/A-1b", "PDF/A-1a", "PDF/A-2b", "PDF/A-2u", "PDF/A-2a", "PDF/A-3b", "PDF/A-3u" and "PDF/A-3a"

Returns: Conformance enumeration item. 0 in case of an error.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsPdf_Conformance_ToStringA()

PDFTOOLS_EXPORT const char *PDFTOOLS_CALL PdfToolsPdf_Conformance_ToStringA ( TPdfToolsPdf_Conformance iConformance )

Create string representation of conformance.

Get null-terminated string from a given conformance item from enumeration TPdfToolsPdf_Conformance.

Parameters

[in] iConformance Conformance enumeration item.

Returns: Null-terminated string that represents a given conformance; NULL in case an invalid conformance level was set.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument

◆ PdfToolsPdf_Conformance_ToStringW()

PDFTOOLS_EXPORT const WCHAR *PDFTOOLS_CALL PdfToolsPdf_Conformance_ToStringW ( TPdfToolsPdf_Conformance iConformance )

Create string representation of conformance.

Get null-terminated string from a given conformance item from enumeration TPdfToolsPdf_Conformance.

Parameters

[in] iConformance Conformance enumeration item.

Returns: Null-terminated string that represents a given conformance; NULL in case an invalid conformance level was set.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument

◆ PdfToolsPdf_Document_Close()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_Close ( TPdfToolsPdf_Document * pObject )

Close object.

Disposable objects that have an associated close method must be closed by invoking this function.

Parameters

[in] pObject Disposable object.

Returns: TRUE if the object was closed successfully; FALSE if an error occured while closing the object. Retrieve the error code by calling PdfTools_GetLastError .

◆ PdfToolsPdf_Document_GetConformance()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_GetConformance	(	TPdfToolsPdf_Document *	pDocument,
		TPdfToolsPdf_Conformance *	pConformance )

The claimed conformance of the document.

This method only returns the claimed conformance level, the document is not validated.

This property can return NULL if the document's conformance is unknown.

Parameters

[in,out]	pDocument	Acts as a handle to the native object of type TPdfToolsPdf_Document.
[out]	pConformance	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetMetadata()

PDFTOOLS_EXPORT TPdfToolsPdf_Metadata *PDFTOOLS_CALL PdfToolsPdf_Document_GetMetadata ( TPdfToolsPdf_Document * pDocument )

The metadata of the document.

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetPageCount()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf_Document_GetPageCount ( TPdfToolsPdf_Document * pDocument )

The number of pages in the document If the document is a collection (also known as PDF Portfolio), then this property is 0.

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when -1 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetPermissions()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_GetPermissions	(	TPdfToolsPdf_Document *	pDocument,
		TPdfToolsPdf_Permission *	pPermissions )

The access permissions applicable for this document.

This property is NULL, if the document is not encrypted.

Note that these permissions might be different from the "Document Restrictions Summary" displayed in Adobe Acrobat. This is because Acrobat's restrictions are also affected by other factors. For example, "Document Assembly" is generally only allowed in Acrobat Pro and not the Acrobat Reader.

Parameters

[in,out]	pDocument	Acts as a handle to the native object of type TPdfToolsPdf_Document.
[out]	pPermissions	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetSignatureFields()

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldList *PDFTOOLS_CALL PdfToolsPdf_Document_GetSignatureFields ( TPdfToolsPdf_Document * pDocument )

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf_DocumentType PDFTOOLS_CALL PdfToolsPdf_Document_GetType ( TPdfToolsPdf_Document * pDocument )

Get actual derived type of base type TPdfToolsPdf_Document.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pDocument Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsPdf_DocumentType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_GetXfa()

PDFTOOLS_EXPORT TPdfToolsPdf_XfaType PDFTOOLS_CALL PdfToolsPdf_Document_GetXfa ( TPdfToolsPdf_Document * pDocument )

Whether the document is an XML Forms Architecture (XFA) or a PDF document While XFA documents may seem like regular PDF documents they are not and cannot be processed by many components (error ePdfTools_Error_UnsupportedFeature). An XFA form is included as a resource in a mere shell PDF. The PDF pages' content is generated dynamically from the XFA data, which is a complex, non-standardized process. For this reason, XFA is forbidden by the ISO Standards ISO 19'005-2 (PDF/A-2) and ISO 32'000-2 (PDF 2.0) and newer. It is recommended to convert XFA documents to PDF using an Adobe product, e.g. by using the "Print to PDF" function of Adobe Acrobat Reader.

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_IsLinearized()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_IsLinearized ( TPdfToolsPdf_Document * pDocument )

Whether the document is linearized.

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_IsSigned()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_IsSigned ( TPdfToolsPdf_Document * pDocument )

Parameters

[in,out] pDocument Acts as a handle to the native object of type TPdfToolsPdf_Document.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Document_OpenA()

PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsPdf_Document_OpenA	(	const TPdfToolsSys_StreamDescriptor *	pStreamDesc,
		const char *	szPassword )

Open a PDF document. Documents opened with this method are read-only and cannot be modified.

Parameters

[in]	pStreamDesc	The stream from which the PDF is read.
[in]	szPassword	The password to open the PDF document. If `NULL` or empty, no password is used.

Returns: The newly created document instance

NULL if there is an error.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_License The license check has failed.
ePdfTools_Error_Password The document is encrypted and the password is invalid.
ePdfTools_Error_Corrupt The document is corrupt or not a PDF.
ePdfTools_Error_UnsupportedFeature The document is an unencrypted wrapper document.
ePdfTools_Error_Generic A generic error occurred.

◆ PdfToolsPdf_Document_OpenW()

PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsPdf_Document_OpenW	(	const TPdfToolsSys_StreamDescriptor *	pStreamDesc,
		const WCHAR *	szPassword )

Open a PDF document. Documents opened with this method are read-only and cannot be modified.

Parameters

[in]	pStreamDesc	The stream from which the PDF is read.
[in]	szPassword	The password to open the PDF document. If `NULL` or empty, no password is used.

Returns: The newly created document instance

NULL if there is an error.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_License The license check has failed.
ePdfTools_Error_Password The document is encrypted and the password is invalid.
ePdfTools_Error_Corrupt The document is corrupt or not a PDF.
ePdfTools_Error_UnsupportedFeature The document is an unencrypted wrapper document.
ePdfTools_Error_Generic A generic error occurred.

◆ PdfToolsPdf_Encryption_GetOwnerPasswordA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetOwnerPasswordA	(	TPdfToolsPdf_Encryption *	pEncryption,
		char *	pBuffer,
		size_t	nBufferSize )

The owner password.

This password is sometimes also referred to as the author’s password. This password grants full access to the document. Not only can the document be opened and read, it also allows the document's security settings, access permissions, and passwords to be changed.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_GetOwnerPasswordW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetOwnerPasswordW	(	TPdfToolsPdf_Encryption *	pEncryption,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The owner password.

This password is sometimes also referred to as the author’s password. This password grants full access to the document. Not only can the document be opened and read, it also allows the document's security settings, access permissions, and passwords to be changed.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_GetPermissions()

PDFTOOLS_EXPORT TPdfToolsPdf_Permission PDFTOOLS_CALL PdfToolsPdf_Encryption_GetPermissions ( TPdfToolsPdf_Encryption * pEncryption )

The access permissions granted when opening the document.

The operations granted in a PDF document are controlled using permission flags. In order to set permission flags, the PDF document must be encrypted and have an owner password.

The restricted permissions apply whenever the document is opened with a password other than the owner password. The owner password is required to initially set or later change the permission flags.

When opening an encrypted document, the access permissions for the document can be read using PdfToolsPdf_Document_GetPermissions. Note that the permissions might be different from the "Document Restrictions Summary" displayed in Adobe Acrobat.

Parameters

[in,out] pEncryption Acts as a handle to the native object of type TPdfToolsPdf_Encryption.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_GetUserPasswordA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetUserPasswordA	(	TPdfToolsPdf_Encryption *	pEncryption,
		char *	pBuffer,
		size_t	nBufferSize )

The user password.

This password protects the document against unauthorized opening and reading.

If a PDF document is protected by a user password, it cannot be opened without a password. The user or, if set, owner password must be provided to open and read the document.

If a document is not protected by a user password, it can be opened by without a password, even if an owner password is set.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_GetUserPasswordW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetUserPasswordW	(	TPdfToolsPdf_Encryption *	pEncryption,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The user password.

This password protects the document against unauthorized opening and reading.

If a PDF document is protected by a user password, it cannot be opened without a password. The user or, if set, owner password must be provided to open and read the document.

If a document is not protected by a user password, it can be opened by without a password, even if an owner password is set.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_NewA()

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_Encryption_NewA	(	const char *	szUserPassword,
		const char *	szOwnerPassword,
		TPdfToolsPdf_Permission	iPermissions )

Parameters

[in]	szUserPassword	Set the user password of the output document (see PdfToolsPdf_Encryption_GetUserPassword). If `NULL` or empty, no user password is set.
[in]	szOwnerPassword	Set the owner password and permissions of the output document (see PdfToolsPdf_Encryption_GetOwnerPassword). If `NULL` or empty, no owner password is set.
[in]	iPermissions	The permissions to be set on the PDF document. If no owner password is set, the permissions must not be restricted, i.e. the `permissions` must be `All`.

Returns: Handle to the newly created native object.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_NewW()

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_Encryption_NewW	(	const WCHAR *	szUserPassword,
		const WCHAR *	szOwnerPassword,
		TPdfToolsPdf_Permission	iPermissions )

Parameters

[in]	szUserPassword	Set the user password of the output document (see PdfToolsPdf_Encryption_GetUserPassword). If `NULL` or empty, no user password is set.
[in]	szOwnerPassword	Set the owner password and permissions of the output document (see PdfToolsPdf_Encryption_GetOwnerPassword). If `NULL` or empty, no owner password is set.
[in]	iPermissions	The permissions to be set on the PDF document. If no owner password is set, the permissions must not be restricted, i.e. the `permissions` must be `All`.

Returns: Handle to the newly created native object.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_SetPermissionsA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Encryption_SetPermissionsA	(	TPdfToolsPdf_Encryption *	pEncryption,
		const char *	szOwnerPassword,
		TPdfToolsPdf_Permission	iPermissions )

Set the owner password and access permissions. Only the given permissions are granted when opening the document. To the owner of the document, all permissions are granted. For this, the document must be opened by specifying the owner password (see PdfToolsPdf_Encryption_GetOwnerPassword).

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[in]	szOwnerPassword	The owner password to be set on the PDF document (see PdfToolsPdf_Encryption_GetOwnerPassword).
[in]	iPermissions	The permissions to be set on the PDF document.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument If restricted iPermissions (i.e. not All) are specified without szOwnerPassword.

◆ PdfToolsPdf_Encryption_SetPermissionsW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Encryption_SetPermissionsW	(	TPdfToolsPdf_Encryption *	pEncryption,
		const WCHAR *	szOwnerPassword,
		TPdfToolsPdf_Permission	iPermissions )

Set the owner password and access permissions. Only the given permissions are granted when opening the document. To the owner of the document, all permissions are granted. For this, the document must be opened by specifying the owner password (see PdfToolsPdf_Encryption_GetOwnerPassword).

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[in]	szOwnerPassword	The owner password to be set on the PDF document (see PdfToolsPdf_Encryption_GetOwnerPassword).
[in]	iPermissions	The permissions to be set on the PDF document.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument If restricted iPermissions (i.e. not All) are specified without szOwnerPassword.

◆ PdfToolsPdf_Encryption_SetUserPasswordA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Encryption_SetUserPasswordA	(	TPdfToolsPdf_Encryption *	pEncryption,
		const char *	szUserPassword )

The user password.

This password protects the document against unauthorized opening and reading.

If a PDF document is protected by a user password, it cannot be opened without a password. The user or, if set, owner password must be provided to open and read the document.

If a document is not protected by a user password, it can be opened by without a password, even if an owner password is set.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[in]	szUserPassword	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note: An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Encryption_SetUserPasswordW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Encryption_SetUserPasswordW	(	TPdfToolsPdf_Encryption *	pEncryption,
		const WCHAR *	szUserPassword )

The user password.

This password protects the document against unauthorized opening and reading.

If a PDF document is protected by a user password, it cannot be opened without a password. The user or, if set, owner password must be provided to open and read the document.

If a document is not protected by a user password, it can be opened by without a password, even if an owner password is set.

If the password contains characters that are not in the Windows ANSI encoding (Windows Code Page 1252), the output document's compliance level is automatically upgraded to PDF version 1.7. This is because older PDF versions do not support Unicode passwords.

Parameters

[in,out]	pEncryption	Acts as a handle to the native object of type TPdfToolsPdf_Encryption.
[in]	szUserPassword	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note: An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Metadata_GetAuthorA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetAuthorA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetAuthorW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetAuthorW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetCreationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Metadata_GetCreationDate	(	TPdfToolsPdf_Metadata *	pMetadata,
		TPdfToolsSys_Date *	pCreationDate )

The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pCreationDate	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetCreatorA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetCreatorA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetCreatorW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetCreatorW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetKeywordsA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetKeywordsA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetKeywordsW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetKeywordsW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetModificationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Metadata_GetModificationDate	(	TPdfToolsPdf_Metadata *	pMetadata,
		TPdfToolsSys_Date *	pModificationDate )

The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pModificationDate	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_Corrupt The date is corrupt.
ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetProducerA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetProducerA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

The application that created the PDF.

If the document was converted to PDF from another format, the name of the PDF processor that converted it to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetProducerW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetProducerW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The application that created the PDF.

If the document was converted to PDF from another format, the name of the PDF processor that converted it to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetSubjectA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetSubjectA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetSubjectW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetSubjectW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetTitleA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetTitleA	(	TPdfToolsPdf_Metadata *	pMetadata,
		char *	pBuffer,
		size_t	nBufferSize )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_Metadata_GetTitleW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetTitleW	(	TPdfToolsPdf_Metadata *	pMetadata,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadata	Acts as a handle to the native object of type TPdfToolsPdf_Metadata.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState if the metadata have already been closed

◆ PdfToolsPdf_MetadataSettings_GetAuthorA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetAuthorA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetAuthorW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetAuthorW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetCreationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetCreationDate	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		TPdfToolsSys_Date *	pCreationDate )

The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pCreationDate	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed
ePdfTools_Error_IllegalArgument The date is invalid.

◆ PdfToolsPdf_MetadataSettings_GetCreatorA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetCreatorA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetCreatorW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetCreatorW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetKeywordsA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetKeywordsA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetKeywordsW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetKeywordsW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetModificationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetModificationDate	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		TPdfToolsSys_Date *	pModificationDate )

The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pModificationDate	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed
ePdfTools_Error_IllegalArgument The date is invalid.

◆ PdfToolsPdf_MetadataSettings_GetProducerA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetProducerA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

The application that created the PDF.

If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetProducerW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetProducerW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The application that created the PDF.

If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetSubjectA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetSubjectA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetSubjectW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetSubjectW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetTitleA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetTitleA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		char *	pBuffer,
		size_t	nBufferSize )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_GetTitleW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_GetTitleW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_New()

PDFTOOLS_EXPORT TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_New ( void )

Returns: Handle to the newly created native object.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_MetadataSettings_SetAuthorA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetAuthorA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szAuthor )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szAuthor	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetAuthorW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetAuthorW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szAuthor )

The name of the person who created the document or resource. This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szAuthor	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetCreationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetCreationDate	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const TPdfToolsSys_Date *	pCreationDate )

The date and time the document or resource was originally created. This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	pCreationDate	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed
ePdfTools_Error_IllegalArgument The date is invalid.

◆ PdfToolsPdf_MetadataSettings_SetCreatorA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetCreatorA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szCreator )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szCreator	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetCreatorW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetCreatorW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szCreator )

The original application that created the document.

The name of the first known tool used to create the document or resource.

This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szCreator	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetKeywordsA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetKeywordsA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szKeywords )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szKeywords	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetKeywordsW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetKeywordsW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szKeywords )

Keywords associated with the document or resource.

Keywords can be separated by:

carriage return / line feed
comma
semicolon
tab
double space

This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szKeywords	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetModificationDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetModificationDate	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const TPdfToolsSys_Date *	pModificationDate )

The date and time the document or resource was most recently modified. This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	pModificationDate	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed
ePdfTools_Error_IllegalArgument The date is invalid.

◆ PdfToolsPdf_MetadataSettings_SetProducerA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetProducerA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szProducer )

The application that created the PDF.

If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szProducer	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetProducerW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetProducerW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szProducer )

The application that created the PDF.

If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szProducer	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetSubjectA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetSubjectA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szSubject )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szSubject	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetSubjectW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetSubjectW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szSubject )

The subject of the document or resource. This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szSubject	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetTitleA()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetTitleA	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const char *	szTitle )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szTitle	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_MetadataSettings_SetTitleW()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetTitleW	(	TPdfToolsPdf_MetadataSettings *	pMetadataSettings,
		const WCHAR *	szTitle )

The title of the document or resource. This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.

Parameters

[in,out]	pMetadataSettings	Acts as a handle to the native object of type TPdfToolsPdf_MetadataSettings.
[in]	szTitle	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the metadata settings have already been closed

◆ PdfToolsPdf_OutputOptions_GetEncryption()

PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetEncryption ( TPdfToolsPdf_OutputOptions * pOutputOptions )

The parameters to encrypt output PDFs.

If NULL, no encryption is used.

Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use NULL when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation.

Default: NULL, no encryption is used.

Parameters

[in,out] pOutputOptions Acts as a handle to the native object of type TPdfToolsPdf_OutputOptions.

Returns: Retrieved value.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when NULL is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_OutputOptions_GetMetadataSettings()

PDFTOOLS_EXPORT TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetMetadataSettings ( TPdfToolsPdf_OutputOptions * pOutputOptions )

Default: NULL, metadata are copied to the output document.

Parameters

[in,out] pOutputOptions Acts as a handle to the native object of type TPdfToolsPdf_OutputOptions.

Returns: Retrieved value.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when NULL is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_OutputOptions_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptionsType PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetType ( TPdfToolsPdf_OutputOptions * pOutputOptions )

Get actual derived type of base type TPdfToolsPdf_OutputOptions.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pOutputOptions Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsPdf_OutputOptionsType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_OutputOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptions *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_New ( void )

Returns: Handle to the newly created native object.

NULL if there is an error.

Note: An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_OutputOptions_SetEncryption()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_OutputOptions_SetEncryption	(	TPdfToolsPdf_OutputOptions *	pOutputOptions,
		TPdfToolsPdf_Encryption *	pEncryption )

The parameters to encrypt output PDFs.

If NULL, no encryption is used.

Encryption is not allowed by the PDF/A ISO standards. For that reason, it is recommended to use NULL when processing PDF/A documents. Otherwise, most operations will remove PDF/A conformance from the output document. More details can be found in the documentation of the operation.

Default: NULL, no encryption is used.

Parameters

[in,out]	pOutputOptions	Acts as a handle to the native object of type TPdfToolsPdf_OutputOptions.
[in,out]	pEncryption	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note: An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_OutputOptions_SetMetadataSettings()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_OutputOptions_SetMetadataSettings	(	TPdfToolsPdf_OutputOptions *	pOutputOptions,
		TPdfToolsPdf_MetadataSettings *	pMetadataSettings )

Default: NULL, metadata are copied to the output document.

Parameters

[in,out]	pOutputOptions	Acts as a handle to the native object of type TPdfToolsPdf_OutputOptions.
[in,out]	pMetadataSettings	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note: An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Revision_IsLatest()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Revision_IsLatest ( TPdfToolsPdf_Revision * pRevision )

Whether this is the latest document revision.

Parameters

[in,out] pRevision Acts as a handle to the native object of type TPdfToolsPdf_Revision.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_Revision_Write()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Revision_Write	(	TPdfToolsPdf_Revision *	pRevision,
		const TPdfToolsSys_StreamDescriptor *	pStreamDesc )

Write the contents of the document revision to a stream.

Parameters

[in,out]	pRevision	Acts as a handle to the native object of type TPdfToolsPdf_Revision.
[out]	pStreamDesc	The stream to which the revision is written.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IO Unable to write to the stream.

◆ PdfToolsPdf_Signature_GetContactInfoA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetContactInfoA	(	TPdfToolsPdf_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetContactInfoW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetContactInfoW	(	TPdfToolsPdf_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature. For example, a phone number.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetLocationA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetLocationA	(	TPdfToolsPdf_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The location of signing The CPU host name or physical location of the signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetLocationW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetLocationW	(	TPdfToolsPdf_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The location of signing The CPU host name or physical location of the signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetReasonA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetReasonA	(	TPdfToolsPdf_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The reason for signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetReasonW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetReasonW	(	TPdfToolsPdf_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The reason for signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPdfToolsPdf_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_Signature_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureType PDFTOOLS_CALL PdfToolsPdf_Signature_GetType ( TPdfToolsPdf_Signature * pSignature )

Get actual derived type of base type TPdfToolsPdf_Signature.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pSignature Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsPdf_SignatureType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_SignatureField_GetBoundingBox()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetBoundingBox	(	TPdfToolsPdf_SignatureField *	pSignatureField,
		TPdfToolsGeomUnits_Rectangle *	pBoundingBox )

The location on the page The location of the signature field on the page. Or NULL if the signature field has no visual appearance.

Parameters

[in,out]	pSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignatureField.
[out]	pBoundingBox	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignatureField_GetFieldNameA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetFieldNameA	(	TPdfToolsPdf_SignatureField *	pSignatureField,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the signature field The field name uniquely identifies the signature field within the document.

Parameters

[in,out]	pSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignatureField_GetFieldNameW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetFieldNameW	(	TPdfToolsPdf_SignatureField *	pSignatureField,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the signature field The field name uniquely identifies the signature field within the document.

Parameters

[in,out]	pSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignatureField_GetPageNumber()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetPageNumber ( TPdfToolsPdf_SignatureField * pSignatureField )

The number of the page where this signature is located Whether the signature field has a visual appearance on that page is indicated by the PdfToolsPdf_SignatureField_GetBoundingBox.

Parameters

[in,out] pSignatureField Acts as a handle to the native object of type TPdfToolsPdf_SignatureField.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed.
ePdfTools_Error_NotFound If the field is not properly linked to a page.

◆ PdfToolsPdf_SignatureField_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldType PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetType ( TPdfToolsPdf_SignatureField * pSignatureField )

Get actual derived type of base type TPdfToolsPdf_SignatureField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pSignatureField Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsPdf_SignatureFieldType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsPdf_SignatureFieldList_Get()

PDFTOOLS_EXPORT TPdfToolsPdf_SignatureField *PDFTOOLS_CALL PdfToolsPdf_SignatureFieldList_Get	(	TPdfToolsPdf_SignatureFieldList *	pSignatureFieldList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pSignatureFieldList	Acts as a handle to the native object of type TPdfToolsPdf_SignatureFieldList.
[in]	iIndex

Returns: NULL if there is an error.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsPdf_SignatureFieldList_GetCount()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf_SignatureFieldList_GetCount ( TPdfToolsPdf_SignatureFieldList * pSignatureFieldList )

Get the number of elements in the list.

Parameters

[in,out] pSignatureFieldList Acts as a handle to the native object of type TPdfToolsPdf_SignatureFieldList.

Returns: May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState

◆ PdfToolsPdf_SignedSignatureField_GetDate()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetDate	(	TPdfToolsPdf_SignedSignatureField *	pSignedSignatureField,
		TPdfToolsSys_Date *	pDate )

The date and time of signing.

This represents the date and time of signing as specified in the signature. For signatures that contain a time-stamp, the trusted time-stamp time is returned.

Note: The value can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats, the date as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignedSignatureField.
[out]	pDate	Retrieved value.

Returns: FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignedSignatureField_GetNameA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetNameA	(	TPdfToolsPdf_SignedSignatureField *	pSignedSignatureField,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the person or authority that signed the document.

This is the name of the signing certificate.

Note: The name of the signing certificate can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats, the name as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignedSignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignedSignatureField_GetNameW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetNameW	(	TPdfToolsPdf_SignedSignatureField *	pSignedSignatureField,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the person or authority that signed the document.

This is the name of the signing certificate.

Note: The name of the signing certificate can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats, the name as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPdfToolsPdf_SignedSignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed

◆ PdfToolsPdf_SignedSignatureField_GetRevision()

PDFTOOLS_EXPORT TPdfToolsPdf_Revision *PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetRevision ( TPdfToolsPdf_SignedSignatureField * pSignedSignatureField )

The document revision The revision (version) of the document that the signature signs.

Parameters

[in,out] pSignedSignatureField Acts as a handle to the native object of type TPdfToolsPdf_SignedSignatureField.

Returns: Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState If the object has already been closed
ePdfTools_Error_Corrupt If the signature specifies an invalid document revision

◆ PdfToolsPdf_SignedSignatureField_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf_SignedSignatureFieldType PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetType ( TPdfToolsPdf_SignedSignatureField * pSignedSignatureField )

Get actual derived type of base type TPdfToolsPdf_SignedSignatureField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pSignedSignatureField Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsPdf_SignedSignatureFieldType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

Macros

Functions

Macro Definition Documentation

◆ PDFTOOLS_CALL

◆ PdfToolsPdf_Document_Open

◆ PdfToolsPdf_Encryption_GetOwnerPassword

◆ PdfToolsPdf_Encryption_GetUserPassword

◆ PdfToolsPdf_Encryption_New

◆ PdfToolsPdf_Encryption_SetPermissions

◆ PdfToolsPdf_Encryption_SetUserPassword

◆ PdfToolsPdf_Metadata_GetAuthor

◆ PdfToolsPdf_Metadata_GetCreator

◆ PdfToolsPdf_Metadata_GetKeywords

◆ PdfToolsPdf_Metadata_GetProducer

◆ PdfToolsPdf_Metadata_GetSubject

◆ PdfToolsPdf_Metadata_GetTitle

◆ PdfToolsPdf_MetadataSettings_GetAuthor

◆ PdfToolsPdf_MetadataSettings_GetCreator

◆ PdfToolsPdf_MetadataSettings_GetKeywords

◆ PdfToolsPdf_MetadataSettings_GetProducer

◆ PdfToolsPdf_MetadataSettings_GetSubject

◆ PdfToolsPdf_MetadataSettings_GetTitle

◆ PdfToolsPdf_MetadataSettings_SetAuthor

◆ PdfToolsPdf_MetadataSettings_SetCreator

◆ PdfToolsPdf_MetadataSettings_SetKeywords

◆ PdfToolsPdf_MetadataSettings_SetProducer

◆ PdfToolsPdf_MetadataSettings_SetSubject

◆ PdfToolsPdf_MetadataSettings_SetTitle

◆ PdfToolsPdf_Signature_GetContactInfo

◆ PdfToolsPdf_Signature_GetLocation

◆ PdfToolsPdf_Signature_GetReason

◆ PdfToolsPdf_SignatureField_GetFieldName

◆ PdfToolsPdf_SignedSignatureField_GetName

Function Documentation

◆ PdfToolsPdf_CertificationSignature_GetPermissions()

◆ PdfToolsPdf_Conformance_ParseA()

◆ PdfToolsPdf_Conformance_ParseW()

◆ PdfToolsPdf_Conformance_ToStringA()

◆ PdfToolsPdf_Conformance_ToStringW()

◆ PdfToolsPdf_Document_Close()

◆ PdfToolsPdf_Document_GetConformance()

◆ PdfToolsPdf_Document_GetMetadata()

◆ PdfToolsPdf_Document_GetPageCount()

◆ PdfToolsPdf_Document_GetPermissions()

◆ PdfToolsPdf_Document_GetSignatureFields()

◆ PdfToolsPdf_Document_GetType()

◆ PdfToolsPdf_Document_GetXfa()

◆ PdfToolsPdf_Document_IsLinearized()

◆ PdfToolsPdf_Document_IsSigned()

◆ PdfToolsPdf_Document_OpenA()

◆ PdfToolsPdf_Document_OpenW()

◆ PdfToolsPdf_Encryption_GetOwnerPasswordA()

◆ PdfToolsPdf_Encryption_GetOwnerPasswordW()

◆ PdfToolsPdf_Encryption_GetPermissions()

◆ PdfToolsPdf_Encryption_GetUserPasswordA()

◆ PdfToolsPdf_Encryption_GetUserPasswordW()

◆ PdfToolsPdf_Encryption_NewA()

◆ PdfToolsPdf_Encryption_NewW()

◆ PdfToolsPdf_Encryption_SetPermissionsA()

◆ PdfToolsPdf_Encryption_SetPermissionsW()

◆ PdfToolsPdf_Encryption_SetUserPasswordA()

◆ PdfToolsPdf_Encryption_SetUserPasswordW()

◆ PdfToolsPdf_Metadata_GetAuthorA()

◆ PdfToolsPdf_Metadata_GetAuthorW()

◆ PdfToolsPdf_Metadata_GetCreationDate()

◆ PdfToolsPdf_Metadata_GetCreatorA()

◆ PdfToolsPdf_Metadata_GetCreatorW()

◆ PdfToolsPdf_Metadata_GetKeywordsA()

◆ PdfToolsPdf_Metadata_GetKeywordsW()

◆ PdfToolsPdf_Metadata_GetModificationDate()

◆ PdfToolsPdf_Metadata_GetProducerA()

◆ PdfToolsPdf_Metadata_GetProducerW()

◆ PdfToolsPdf_Metadata_GetSubjectA()

◆ PdfToolsPdf_Metadata_GetSubjectW()

◆ PdfToolsPdf_Metadata_GetTitleA()

◆ PdfToolsPdf_Metadata_GetTitleW()

◆ PdfToolsPdf_MetadataSettings_GetAuthorA()

◆ PdfToolsPdf_MetadataSettings_GetAuthorW()

◆ PdfToolsPdf_MetadataSettings_GetCreationDate()

◆ PdfToolsPdf_MetadataSettings_GetCreatorA()