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 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_PDFTOOLSPDF_H__
20#define PDFTOOLS_PDFTOOLSPDF_H__
21
22#ifndef PDFTOOLS_CALL
23#if defined(WIN32)
24#define PDFTOOLS_CALL __stdcall
25#else
26#define PDFTOOLS_CALL
27#endif
28#endif
29
30#include "PdfTools_Types.h"
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleW
40#define PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleW
41#define PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorW
42#define PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorW
43#define PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectW
44#define PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectW
45#define PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsW
46#define PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsW
47#define PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorW
48#define PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorW
49#define PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerW
50#define PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerW
51
52#define PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewW
53#define PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsW
54
55#define PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordW
56#define PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordW
57#define PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordW
58
59#define PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenW
60
61#define PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleW
62
63#define PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorW
64
65#define PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectW
66
67#define PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsW
68
69#define PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorW
70
71#define PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerW
72
73#define PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameW
74
75#define PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameW
76
77#define PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationW
78
79#define PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonW
80
81#define PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoW
82
83#else
84#define PdfToolsPdf_MetadataSettings_GetTitle PdfToolsPdf_MetadataSettings_GetTitleA
85#define PdfToolsPdf_MetadataSettings_SetTitle PdfToolsPdf_MetadataSettings_SetTitleA
86#define PdfToolsPdf_MetadataSettings_GetAuthor PdfToolsPdf_MetadataSettings_GetAuthorA
87#define PdfToolsPdf_MetadataSettings_SetAuthor PdfToolsPdf_MetadataSettings_SetAuthorA
88#define PdfToolsPdf_MetadataSettings_GetSubject PdfToolsPdf_MetadataSettings_GetSubjectA
89#define PdfToolsPdf_MetadataSettings_SetSubject PdfToolsPdf_MetadataSettings_SetSubjectA
90#define PdfToolsPdf_MetadataSettings_GetKeywords PdfToolsPdf_MetadataSettings_GetKeywordsA
91#define PdfToolsPdf_MetadataSettings_SetKeywords PdfToolsPdf_MetadataSettings_SetKeywordsA
92#define PdfToolsPdf_MetadataSettings_GetCreator PdfToolsPdf_MetadataSettings_GetCreatorA
93#define PdfToolsPdf_MetadataSettings_SetCreator PdfToolsPdf_MetadataSettings_SetCreatorA
94#define PdfToolsPdf_MetadataSettings_GetProducer PdfToolsPdf_MetadataSettings_GetProducerA
95#define PdfToolsPdf_MetadataSettings_SetProducer PdfToolsPdf_MetadataSettings_SetProducerA
96
97#define PdfToolsPdf_Encryption_New PdfToolsPdf_Encryption_NewA
98#define PdfToolsPdf_Encryption_SetPermissions PdfToolsPdf_Encryption_SetPermissionsA
99
100#define PdfToolsPdf_Encryption_GetUserPassword PdfToolsPdf_Encryption_GetUserPasswordA
101#define PdfToolsPdf_Encryption_SetUserPassword PdfToolsPdf_Encryption_SetUserPasswordA
102#define PdfToolsPdf_Encryption_GetOwnerPassword PdfToolsPdf_Encryption_GetOwnerPasswordA
103
104#define PdfToolsPdf_Document_Open PdfToolsPdf_Document_OpenA
105
106#define PdfToolsPdf_Metadata_GetTitle PdfToolsPdf_Metadata_GetTitleA
107
108#define PdfToolsPdf_Metadata_GetAuthor PdfToolsPdf_Metadata_GetAuthorA
109
110#define PdfToolsPdf_Metadata_GetSubject PdfToolsPdf_Metadata_GetSubjectA
111
112#define PdfToolsPdf_Metadata_GetKeywords PdfToolsPdf_Metadata_GetKeywordsA
113
114#define PdfToolsPdf_Metadata_GetCreator PdfToolsPdf_Metadata_GetCreatorA
115
116#define PdfToolsPdf_Metadata_GetProducer PdfToolsPdf_Metadata_GetProducerA
117
118#define PdfToolsPdf_SignatureField_GetFieldName PdfToolsPdf_SignatureField_GetFieldNameA
119
120#define PdfToolsPdf_SignedSignatureField_GetName PdfToolsPdf_SignedSignatureField_GetNameA
121
122#define PdfToolsPdf_Signature_GetLocation PdfToolsPdf_Signature_GetLocationA
123
124#define PdfToolsPdf_Signature_GetReason PdfToolsPdf_Signature_GetReasonA
125
126#define PdfToolsPdf_Signature_GetContactInfo PdfToolsPdf_Signature_GetContactInfoA
127
128#endif
129
130/******************************************************************************
131 * MetadataSettings
132 *****************************************************************************/
142
170 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
198 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
270 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
298 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
370 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
398 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
478 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
514 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
605 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
636 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
718 TPdfToolsPdf_MetadataSettings* pMetadataSettings, char* pBuffer, size_t nBufferSize);
750 TPdfToolsPdf_MetadataSettings* pMetadataSettings, WCHAR* pBuffer, size_t nBufferSize);
827 TPdfToolsPdf_MetadataSettings* pMetadataSettings, TPdfToolsSys_Date* pCreationDate);
851 TPdfToolsPdf_MetadataSettings* pMetadataSettings, const TPdfToolsSys_Date* pCreationDate);
876 TPdfToolsPdf_MetadataSettings* pMetadataSettings, TPdfToolsSys_Date* pModificationDate);
900 TPdfToolsPdf_MetadataSettings* pMetadataSettings, const TPdfToolsSys_Date* pModificationDate);
901
902/******************************************************************************
903 * Encryption
904 *****************************************************************************/
924 const char* szUserPassword, const char* szOwnerPassword, TPdfToolsPdf_Permission iPermissions);
944 const WCHAR* szUserPassword, const WCHAR* szOwnerPassword, TPdfToolsPdf_Permission iPermissions);
945
972 const char* szOwnerPassword,
973 TPdfToolsPdf_Permission iPermissions);
1000 const WCHAR* szOwnerPassword,
1001 TPdfToolsPdf_Permission iPermissions);
1002
1036 char* pBuffer, size_t nBufferSize);
1070 WCHAR* pBuffer, size_t nBufferSize);
1098 const char* szUserPassword);
1126 const WCHAR* szUserPassword);
1157 char* pBuffer, size_t nBufferSize);
1188 WCHAR* pBuffer, size_t nBufferSize);
1214
1215/******************************************************************************
1216 * OutputOptions
1217 *****************************************************************************/
1227
1278 TPdfToolsPdf_Encryption* pEncryption);
1311 TPdfToolsPdf_OutputOptions* pOutputOptions, TPdfToolsPdf_MetadataSettings* pMetadataSettings);
1312
1328/******************************************************************************
1329 * Document
1330 *****************************************************************************/
1360PdfToolsPdf_Document_OpenA(const TPdfToolsSys_StreamDescriptor* pStreamDesc, const char* szPassword);
1391
1413 TPdfToolsPdf_Conformance* pConformance);
1451 TPdfToolsPdf_Permission* pPermissions);
1524
1550/******************************************************************************
1551 * Metadata
1552 *****************************************************************************/
1580 size_t nBufferSize);
1608 size_t nBufferSize);
1636 size_t nBufferSize);
1664 size_t nBufferSize);
1692 size_t nBufferSize);
1720 size_t nBufferSize);
1756 size_t nBufferSize);
1792 size_t nBufferSize);
1823 size_t nBufferSize);
1854 size_t nBufferSize);
1886 size_t nBufferSize);
1918 size_t nBufferSize);
1941 TPdfToolsSys_Date* pCreationDate);
1966 TPdfToolsSys_Date* pModificationDate);
1967
1968/******************************************************************************
1969 * SignatureField
1970 *****************************************************************************/
1996 TPdfToolsPdf_SignatureField* pSignatureField, char* pBuffer, size_t nBufferSize);
2022 TPdfToolsPdf_SignatureField* pSignatureField, WCHAR* pBuffer, size_t nBufferSize);
2066 TPdfToolsPdf_SignatureField* pSignatureField, TPdfToolsGeomUnits_Rectangle* pBoundingBox);
2067
2083/******************************************************************************
2084 * SignedSignatureField
2085 *****************************************************************************/
2117 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, char* pBuffer, size_t nBufferSize);
2149 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, WCHAR* pBuffer, size_t nBufferSize);
2177 TPdfToolsPdf_SignedSignatureField* pSignedSignatureField, TPdfToolsSys_Date* pDate);
2200
2216/******************************************************************************
2217 * Signature
2218 *****************************************************************************/
2244 char* pBuffer, size_t nBufferSize);
2270 WCHAR* pBuffer, size_t nBufferSize);
2294 size_t nBufferSize);
2318 WCHAR* pBuffer, size_t nBufferSize);
2346 char* pBuffer, size_t nBufferSize);
2374 WCHAR* pBuffer, size_t nBufferSize);
2375
2391/******************************************************************************
2392 * CertificationSignature
2393 *****************************************************************************/
2415
2416/******************************************************************************
2417 * SignatureFieldList
2418 *****************************************************************************/
2450
2451/******************************************************************************
2452 * Revision
2453 *****************************************************************************/
2471 const TPdfToolsSys_StreamDescriptor* pStreamDesc);
2472
2487
2554
2555#ifdef __cplusplus
2556}
2557#endif
2558
2559#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:26
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:143
unsigned short WCHAR
Definition PdfTools_Platform.h:95
TPdfToolsPdf_DocumentType
Type and subtype enumeration of TPdfToolsPdf_Document.
Definition PdfTools_Types.h:1805
TPdfToolsPdf_Conformance
Definition PdfTools_Types.h:198
TPdfToolsPdf_Permission
The permissions allowed by a PDF document.
Definition PdfTools_Types.h:99
TPdfToolsPdf_SignedSignatureFieldType
Type and subtype enumeration of TPdfToolsPdf_SignedSignatureField.
Definition PdfTools_Types.h:1854
TPdfToolsPdf_SignatureType
Type and subtype enumeration of TPdfToolsPdf_Signature.
Definition PdfTools_Types.h:1878
TPdfToolsPdf_SignatureFieldType
Type and subtype enumeration of TPdfToolsPdf_SignatureField.
Definition PdfTools_Types.h:1827
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:145
TPdfToolsPdf_MdpPermissions
Definition PdfTools_Types.h:173
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsPdf_OutputOptionsType
Type and subtype enumeration of TPdfToolsPdf_OutputOptions.
Definition PdfTools_Types.h:1784
A document certification (MDP) signature that certifies the document These signatures are also called...
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
The parameters to encrypt PDF documents.
The parameters for document-level features of output PDFs Output options are used in many operations ...
The document revision.
A digital signature field.
A base class for certain signature types.
A base class for signature fields that have been signed The existence of a signed signature field doe...
Definition PdfTools_Types.h:3378
Definition PdfTools_Types.h:3398
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49