Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsPdf.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsPdf.h
4 *
5 * Description: Sub Header file for Pdftools SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSPDF_H__
15#define PDFTOOLS_PDFTOOLSPDF_H__
16
17#ifndef PDFTOOLS_CALL
18#if defined(WIN32)
19#define PDFTOOLS_CALL __stdcall
20#else
21#define PDFTOOLS_CALL
22#endif
23#endif
24
25#include "PdfTools_Types.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleW
35#define PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleW
36#define PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorW
37#define PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorW
38#define PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectW
39#define PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectW
40#define PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsW
41#define PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsW
42#define PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorW
43#define PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorW
44#define PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerW
45#define PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerW
46
47#define PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewW
48#define PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsW
49
50#define PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordW
51#define PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordW
52#define PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordW
53
54#define PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenW
55
56#define PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleW
57
58#define PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorW
59
60#define PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectW
61
62#define PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsW
63
64#define PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorW
65
66#define PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerW
67
68#define PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameW
69
70#define PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameW
71
72#define PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationW
73
74#define PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonW
75
76#define PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoW
77
78#else
79#define PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleA
80#define PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleA
81#define PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorA
82#define PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorA
83#define PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectA
84#define PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectA
85#define PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsA
86#define PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsA
87#define PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorA
88#define PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorA
89#define PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerA
90#define PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerA
91
92#define PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewA
93#define PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsA
94
95#define PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordA
96#define PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordA
97#define PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordA
98
99#define PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenA
100
101#define PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleA
102
103#define PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorA
104
105#define PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectA
106
107#define PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsA
108
109#define PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorA
110
111#define PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerA
112
113#define PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameA
114
115#define PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameA
116
117#define PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationA
118
119#define PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonA
120
121#define PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoA
122
123#endif
124
125/******************************************************************************
126 * MetadataSettings
127 *****************************************************************************/
138
166 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
194 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
266 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
294 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
366 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
394 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
474 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
510 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
601 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
632 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
714 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
746 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
823 TPdfToolsPdf_MetadataSettings* pMetadataSettings, TPdfToolsSys_Date* pCreationDate);
847 TPdfToolsPdf_MetadataSettings* pMetadataSettings, const TPdfToolsSys_Date* pCreationDate);
872 TPdfToolsPdf_MetadataSettings* pMetadataSettings, TPdfToolsSys_Date* pModificationDate);
896 TPdfToolsPdf_MetadataSettings* pMetadataSettings, const TPdfToolsSys_Date* pModificationDate);
897
898/******************************************************************************
899 * Encryption
900 *****************************************************************************/
921 const char* szUserPassword, const char* szOwnerPassword, TPdfToolsPdf_Permission iPermissions);
942 const WCHAR* szUserPassword, const WCHAR* szOwnerPassword, TPdfToolsPdf_Permission iPermissions);
943
970 const char* szOwnerPassword,
971 TPdfToolsPdf_Permission iPermissions);
998 const WCHAR* szOwnerPassword,
999 TPdfToolsPdf_Permission iPermissions);
1000
1034 char* pBuffer, size_t nBufferSize);
1068 WCHAR* pBuffer, size_t nBufferSize);
1096 const char* szUserPassword);
1124 const WCHAR* szUserPassword);
1155 char* pBuffer, size_t nBufferSize);
1186 WCHAR* pBuffer, size_t nBufferSize);
1213
1214/******************************************************************************
1215 * OutputOptions
1216 *****************************************************************************/
1227
1278 TPdfToolsPdf_Encryption* pEncryption);
1311 TPdfToolsPdf_OutputOptions* pOutputOptions, TPdfToolsPdf_MetadataSettings* pMetadataSettings);
1312
1328/******************************************************************************
1329 * Document
1330 *****************************************************************************/
1361PdfToolsPdf_Document_OpenA(const TPdfToolsSys_StreamDescriptor* pStreamDesc, const char* szPassword);
1393
1415 TPdfToolsPdf_Conformance* pConformance);
1454 TPdfToolsPdf_Permission* pPermissions);
1530
1556/******************************************************************************
1557 * Metadata
1558 *****************************************************************************/
1586 size_t nBufferSize);
1614 size_t nBufferSize);
1642 size_t nBufferSize);
1670 size_t nBufferSize);
1698 size_t nBufferSize);
1726 size_t nBufferSize);
1762 size_t nBufferSize);
1798 size_t nBufferSize);
1829 size_t nBufferSize);
1860 size_t nBufferSize);
1892 size_t nBufferSize);
1924 size_t nBufferSize);
1947 TPdfToolsSys_Date* pCreationDate);
1972 TPdfToolsSys_Date* pModificationDate);
1973
1974/******************************************************************************
1975 * SignatureField
1976 *****************************************************************************/
2002 TPdfToolsPdf_SignatureField* pSignatureField, char* pBuffer, size_t nBufferSize);
2028 TPdfToolsPdf_SignatureField* pSignatureField, WCHAR* pBuffer, size_t nBufferSize);
2073 TPdfToolsPdf_SignatureField* pSignatureField, TPdfToolsGeomUnits_Rectangle* pBoundingBox);
2074
2090/******************************************************************************
2091 * SignedSignatureField
2092 *****************************************************************************/
2124 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, char* pBuffer, size_t nBufferSize);
2156 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, WCHAR* pBuffer, size_t nBufferSize);
2184 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, TPdfToolsSys_Date* pDate);
2208
2224/******************************************************************************
2225 * Signature
2226 *****************************************************************************/
2252 char* pBuffer, size_t nBufferSize);
2278 WCHAR* pBuffer, size_t nBufferSize);
2302 size_t nBufferSize);
2326 WCHAR* pBuffer, size_t nBufferSize);
2354 char* pBuffer, size_t nBufferSize);
2382 WCHAR* pBuffer, size_t nBufferSize);
2383
2399/******************************************************************************
2400 * CertificationSignature
2401 *****************************************************************************/
2424
2425/******************************************************************************
2426 * SignatureFieldList
2427 *****************************************************************************/
2461
2462/******************************************************************************
2463 * Revision
2464 *****************************************************************************/
2482 const TPdfToolsSys_StreamDescriptor* pStreamDesc);
2483
2498
2567
2568#ifdef __cplusplus
2569}
2570#endif
2571
2572#endif /* PDFTOOLS_PDFTOOLSPDF_H__ */
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 con...
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 t...
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 th...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_OutputOptions_SetEncryption(TPdfToolsPdf_OutputOptions *pOutputOptions, TPdfToolsPdf_Encryption *pEncryption)
The parameters to encrypt output PDFs.
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 m...
PDFTOOLS_EXPORT TPdfToolsPdf_Metadata *PDFTOOLS_CALL PdfToolsPdf_Document_GetMetadata(TPdfToolsPdf_Document *pDocument)
The metadata of the document.
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_MetadataSettings_GetProducerW(TPdfToolsPdf_MetadataSettings *pMetadataSettings, WCHAR *pBuffer, size_t nBufferSize)
The application that created the PDF.
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 t...
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_SetCreationDate(TPdfToolsPdf_MetadataSettings *pMetadataSettings, const TPdfToolsSys_Date *pCreationDate)
The date and time the document or resource was originally created. This property corresponds to the "...
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:cre...
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 TPdfToolsPdf_MdpPermissions PDFTOOLS_CALL PdfToolsPdf_CertificationSignature_GetPermissions(TPdfToolsPdf_CertificationSignature *pCertificationSignature)
The access permissions granted for this document Note that for encrypted PDF documents,...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetOwnerPasswordA(TPdfToolsPdf_Encryption *pEncryption, char *pBuffer, size_t nBufferSize)
The owner password.
PDFTOOLS_EXPORT TPdfToolsPdf_Conformance PDFTOOLS_CALL PdfToolsPdf_Conformance_ParseW(const WCHAR *szConformanceString)
Parse conformance string.
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 t...
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 TPdfToolsPdf_SignedSignatureFieldType PDFTOOLS_CALL PdfToolsPdf_SignedSignatureField_GetType(TPdfToolsPdf_SignedSignatureField *pSignedSignatureField)
Get actual derived type of base type TPdfToolsPdf_SignedSignatureField.
PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptions *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_New(void)
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 TPdfToolsPdf_SignatureType PDFTOOLS_CALL PdfToolsPdf_Signature_GetType(TPdfToolsPdf_Signature *pSignature)
Get actual derived type of base type TPdfToolsPdf_Signature.
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 const WCHAR *PDFTOOLS_CALL PdfToolsPdf_Conformance_ToStringW(TPdfToolsPdf_Conformance iConformance)
Create string representation of conformance.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetCreatorA(TPdfToolsPdf_MetadataSettings *pMetadataSettings, const char *szCreator)
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 BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetKeywordsA(TPdfToolsPdf_MetadataSettings *pMetadataSettings, const char *szKeywords)
Keywords associated with the document or resource.
PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldList *PDFTOOLS_CALL PdfToolsPdf_Document_GetSignatureFields(TPdfToolsPdf_Document *pDocument)
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 fi...
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_Encryption_GetUserPasswordA(TPdfToolsPdf_Encryption *pEncryption, char *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_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 m...
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 TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Encryption_SetUserPasswordW(TPdfToolsPdf_Encryption *pEncryption, const WCHAR *szUserPassword)
The user password.
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 "...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Revision_IsLatest(TPdfToolsPdf_Revision *pRevision)
Whether this is the latest document revision.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_IsLinearized(TPdfToolsPdf_Document *pDocument)
Whether the document is linearized.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_GetConformance(TPdfToolsPdf_Document *pDocument, TPdfToolsPdf_Conformance *pConformance)
The claimed conformance of the document.
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 m...
PDFTOOLS_EXPORT TPdfToolsPdf_OutputOptionsType PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetType(TPdfToolsPdf_OutputOptions *pOutputOptions)
Get actual derived type of base type TPdfToolsPdf_OutputOptions.
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 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 size_t PDFTOOLS_CALL PdfToolsPdf_Metadata_GetCreatorW(TPdfToolsPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The original application that created the document.
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 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 see...
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 size_t PDFTOOLS_CALL PdfToolsPdf_Signature_GetReasonA(TPdfToolsPdf_Signature *pSignature, char *pBuffer, size_t nBufferSize)
The reason for signing.
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 t...
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_Signature_GetReasonW(TPdfToolsPdf_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
The reason for signing.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetUserPasswordW(TPdfToolsPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)
The user password.
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 m...
PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_Encryption_NewA(const char *szUserPassword, const char *szOwnerPassword, TPdfToolsPdf_Permission iPermissions)
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 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 t...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_Close(TPdfToolsPdf_Document *pObject)
Close object.
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 t...
PDFTOOLS_EXPORT TPdfToolsPdf_MetadataSettings *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetMetadataSettings(TPdfToolsPdf_OutputOptions *pOutputOptions)
PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_Encryption_NewW(const WCHAR *szUserPassword, const WCHAR *szOwnerPassword, TPdfToolsPdf_Permission iPermissions)
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 t...
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 "...
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 m...
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 appea...
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 th...
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 doc...
PDFTOOLS_EXPORT TPdfToolsPdf_DocumentType PDFTOOLS_CALL PdfToolsPdf_Document_GetType(TPdfToolsPdf_Document *pDocument)
Get actual derived type of base type TPdfToolsPdf_Document.
PDFTOOLS_EXPORT const char *PDFTOOLS_CALL PdfToolsPdf_Conformance_ToStringA(TPdfToolsPdf_Conformance iConformance)
Create string representation of conformance.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetCreatorW(TPdfToolsPdf_MetadataSettings *pMetadataSettings, const WCHAR *szCreator)
The original application that created the document.
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_Metadata_GetProducerW(TPdfToolsPdf_Metadata *pMetadata, WCHAR *pBuffer, size_t nBufferSize)
The application that created the PDF.
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:cre...
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_SignedSignatureField_GetDate(TPdfToolsPdf_SignedSignatureField *pSignedSignatureField, TPdfToolsSys_Date *pDate)
The date and time of signing.
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsPdf.h:21
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 doc...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsPdf_Encryption_GetOwnerPasswordW(TPdfToolsPdf_Encryption *pEncryption, WCHAR *pBuffer, size_t nBufferSize)
The owner password.
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 con...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_GetPermissions(TPdfToolsPdf_Document *pDocument, TPdfToolsPdf_Permission *pPermissions)
The access permissions applicable for this document.
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:cre...
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:cre...
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:cre...
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),...
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 t...
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 t...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_OutputOptions_SetMetadataSettings(TPdfToolsPdf_OutputOptions *pOutputOptions, TPdfToolsPdf_MetadataSettings *pMetadataSettings)
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf_SignatureFieldList_GetCount(TPdfToolsPdf_SignatureFieldList *pSignatureFieldList)
Get the number of elements in the list.
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 TPdfToolsPdf_Conformance PDFTOOLS_CALL PdfToolsPdf_Conformance_ParseA(const char *szConformanceString)
Parse conformance string.
PDFTOOLS_EXPORT TPdfToolsPdf_SignatureFieldType PDFTOOLS_CALL PdfToolsPdf_SignatureField_GetType(TPdfToolsPdf_SignatureField *pSignatureField)
Get actual derived type of base type TPdfToolsPdf_SignatureField.
PDFTOOLS_EXPORT TPdfToolsPdf_Permission PDFTOOLS_CALL PdfToolsPdf_Encryption_GetPermissions(TPdfToolsPdf_Encryption *pEncryption)
The access permissions granted when opening the document.
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 m...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_MetadataSettings_SetProducerA(TPdfToolsPdf_MetadataSettings *pMetadataSettings, const char *szProducer)
The application that created the PDF.
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:cre...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf_Document_IsSigned(TPdfToolsPdf_Document *pDocument)
PDFTOOLS_EXPORT TPdfToolsPdf_Encryption *PDFTOOLS_CALL PdfToolsPdf_OutputOptions_GetEncryption(TPdfToolsPdf_OutputOptions *pOutputOptions)
The parameters to encrypt output PDFs.
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 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.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:138
unsigned short WCHAR
Definition PdfTools_Platform.h:90
TPdfToolsPdf_DocumentType
Type and subtype enumeration of TPdfToolsPdf_Document.
Definition PdfTools_Types.h:1736
TPdfToolsPdf_Conformance
Definition PdfTools_Types.h:193
struct TPdfToolsPdf_OutputOptions TPdfToolsPdf_OutputOptions
The parameters for document-level features of output PDFs Output options are used in many operations ...
Definition PdfTools_Types.h:2217
TPdfToolsPdf_Permission
The permissions allowed by a PDF document.
Definition PdfTools_Types.h:94
TPdfToolsPdf_SignedSignatureFieldType
Type and subtype enumeration of TPdfToolsPdf_SignedSignatureField.
Definition PdfTools_Types.h:1785
struct TPdfToolsPdf_Revision TPdfToolsPdf_Revision
The document revision.
Definition PdfTools_Types.h:2288
struct TPdfToolsPdf_SignatureFieldList TPdfToolsPdf_SignatureFieldList
Definition PdfTools_Types.h:2284
TPdfToolsPdf_SignatureType
Type and subtype enumeration of TPdfToolsPdf_Signature.
Definition PdfTools_Types.h:1810
struct TPdfToolsPdf_MetadataSettings TPdfToolsPdf_MetadataSettings
Definition PdfTools_Types.h:2178
struct TPdfToolsPdf_CertificationSignature TPdfToolsPdf_CertificationSignature
A document certification (MDP) signature that certifies the document These signatures are also called...
Definition PdfTools_Types.h:2274
TPdfToolsPdf_SignatureFieldType
Type and subtype enumeration of TPdfToolsPdf_SignatureField.
Definition PdfTools_Types.h:1758
struct TPdfToolsPdf_Signature TPdfToolsPdf_Signature
A base class for certain signature types.
Definition PdfTools_Types.h:2259
TPdfToolsPdf_XfaType
The XFA type of a PDF document See PdfToolsPdf_Document_GetXfa to get the XFA type of a PDF document.
Definition PdfTools_Types.h:140
struct TPdfToolsPdf_SignatureField TPdfToolsPdf_SignatureField
A digital signature field.
Definition PdfTools_Types.h:2239
struct TPdfToolsPdf_SignedSignatureField TPdfToolsPdf_SignedSignatureField
A base class for signature fields that have been signed The existence of a signed signature field doe...
Definition PdfTools_Types.h:2255
struct TPdfToolsPdf_Metadata TPdfToolsPdf_Metadata
Definition PdfTools_Types.h:2235
TPdfToolsPdf_MdpPermissions
Definition PdfTools_Types.h:168
#define BOOL
Definition PdfTools_Types.h:18
struct TPdfToolsPdf_Encryption TPdfToolsPdf_Encryption
The parameters to encrypt PDF documents.
Definition PdfTools_Types.h:2211
TPdfToolsPdf_OutputOptionsType
Type and subtype enumeration of TPdfToolsPdf_OutputOptions.
Definition PdfTools_Types.h:1715
struct TPdfToolsPdf_Document TPdfToolsPdf_Document
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
Definition PdfTools_Types.h:2224
Definition PdfTools_Types.h:3188
Definition PdfTools_Types.h:3208
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44