Pdftools SDK
Loading...
Searching...
No Matches
PdfTools_PdfToolsSign.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_PdfToolsSign.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_PDFTOOLSSIGN_H__
20#define PDFTOOLS_PDFTOOLSSIGN_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 PdfToolsSign_CustomTextVariableMap_Get PdfToolsSign_CustomTextVariableMap_GetW
40#define PdfToolsSign_CustomTextVariableMap_GetKey PdfToolsSign_CustomTextVariableMap_GetKeyW
41#define PdfToolsSign_CustomTextVariableMap_GetValue PdfToolsSign_CustomTextVariableMap_GetValueW
42#define PdfToolsSign_CustomTextVariableMap_Set PdfToolsSign_CustomTextVariableMap_SetW
43#define PdfToolsSign_CustomTextVariableMap_SetValue PdfToolsSign_CustomTextVariableMap_SetValueW
44
45#define PdfToolsSign_SignatureConfiguration_GetFieldName PdfToolsSign_SignatureConfiguration_GetFieldNameW
46#define PdfToolsSign_SignatureConfiguration_SetFieldName PdfToolsSign_SignatureConfiguration_SetFieldNameW
47#define PdfToolsSign_SignatureConfiguration_GetName PdfToolsSign_SignatureConfiguration_GetNameW
48
49#define PdfToolsSign_SignatureConfiguration_GetLocation PdfToolsSign_SignatureConfiguration_GetLocationW
50#define PdfToolsSign_SignatureConfiguration_SetLocation PdfToolsSign_SignatureConfiguration_SetLocationW
51#define PdfToolsSign_SignatureConfiguration_GetReason PdfToolsSign_SignatureConfiguration_GetReasonW
52#define PdfToolsSign_SignatureConfiguration_SetReason PdfToolsSign_SignatureConfiguration_SetReasonW
53#define PdfToolsSign_SignatureConfiguration_GetContactInfo PdfToolsSign_SignatureConfiguration_GetContactInfoW
54#define PdfToolsSign_SignatureConfiguration_SetContactInfo PdfToolsSign_SignatureConfiguration_SetContactInfoW
55
56#define PdfToolsSign_TimestampConfiguration_GetFieldName PdfToolsSign_TimestampConfiguration_GetFieldNameW
57#define PdfToolsSign_TimestampConfiguration_SetFieldName PdfToolsSign_TimestampConfiguration_SetFieldNameW
58
59#define PdfToolsSign_SignatureFieldOptions_GetFieldName PdfToolsSign_SignatureFieldOptions_GetFieldNameW
60#define PdfToolsSign_SignatureFieldOptions_SetFieldName PdfToolsSign_SignatureFieldOptions_SetFieldNameW
61
62#define TPdfToolsSign_Signer_Warning TPdfToolsSign_Signer_WarningW
63#define PdfToolsSign_Signer_AddWarningHandler PdfToolsSign_Signer_AddWarningHandlerW
64#define PdfToolsSign_Signer_RemoveWarningHandler PdfToolsSign_Signer_RemoveWarningHandlerW
65
66#else
67#define PdfToolsSign_CustomTextVariableMap_Get PdfToolsSign_CustomTextVariableMap_GetA
68#define PdfToolsSign_CustomTextVariableMap_GetKey PdfToolsSign_CustomTextVariableMap_GetKeyA
69#define PdfToolsSign_CustomTextVariableMap_GetValue PdfToolsSign_CustomTextVariableMap_GetValueA
70#define PdfToolsSign_CustomTextVariableMap_Set PdfToolsSign_CustomTextVariableMap_SetA
71#define PdfToolsSign_CustomTextVariableMap_SetValue PdfToolsSign_CustomTextVariableMap_SetValueA
72
73#define PdfToolsSign_SignatureConfiguration_GetFieldName PdfToolsSign_SignatureConfiguration_GetFieldNameA
74#define PdfToolsSign_SignatureConfiguration_SetFieldName PdfToolsSign_SignatureConfiguration_SetFieldNameA
75#define PdfToolsSign_SignatureConfiguration_GetName PdfToolsSign_SignatureConfiguration_GetNameA
76
77#define PdfToolsSign_SignatureConfiguration_GetLocation PdfToolsSign_SignatureConfiguration_GetLocationA
78#define PdfToolsSign_SignatureConfiguration_SetLocation PdfToolsSign_SignatureConfiguration_SetLocationA
79#define PdfToolsSign_SignatureConfiguration_GetReason PdfToolsSign_SignatureConfiguration_GetReasonA
80#define PdfToolsSign_SignatureConfiguration_SetReason PdfToolsSign_SignatureConfiguration_SetReasonA
81#define PdfToolsSign_SignatureConfiguration_GetContactInfo PdfToolsSign_SignatureConfiguration_GetContactInfoA
82#define PdfToolsSign_SignatureConfiguration_SetContactInfo PdfToolsSign_SignatureConfiguration_SetContactInfoA
83
84#define PdfToolsSign_TimestampConfiguration_GetFieldName PdfToolsSign_TimestampConfiguration_GetFieldNameA
85#define PdfToolsSign_TimestampConfiguration_SetFieldName PdfToolsSign_TimestampConfiguration_SetFieldNameA
86
87#define PdfToolsSign_SignatureFieldOptions_GetFieldName PdfToolsSign_SignatureFieldOptions_GetFieldNameA
88#define PdfToolsSign_SignatureFieldOptions_SetFieldName PdfToolsSign_SignatureFieldOptions_SetFieldNameA
89
90#define TPdfToolsSign_Signer_Warning TPdfToolsSign_Signer_WarningA
91#define PdfToolsSign_Signer_AddWarningHandler PdfToolsSign_Signer_AddWarningHandlerA
92#define PdfToolsSign_Signer_RemoveWarningHandler PdfToolsSign_Signer_RemoveWarningHandlerA
93
94#endif
95
108typedef void(PDFTOOLS_CALL* TPdfToolsSign_Signer_WarningA)(void* pContext, const char* szMessage,
110 const char* szContext);
123typedef void(PDFTOOLS_CALL* TPdfToolsSign_Signer_WarningW)(void* pContext, const WCHAR* szMessage,
125 const WCHAR* szContext);
126
127/******************************************************************************
128 * CustomTextVariableMap
129 *****************************************************************************/
275 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const WCHAR* szKey);
299 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, char* pBuffer, size_t nBufferSize);
323 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, WCHAR* pBuffer, size_t nBufferSize);
347 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, char* pBuffer, size_t nBufferSize);
371 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, WCHAR* pBuffer, size_t nBufferSize);
395 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const char* szKey, const char* szValue);
419 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const WCHAR* szKey, const WCHAR* szValue);
439 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, const char* szValue);
459 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, const WCHAR* szValue);
496
497/******************************************************************************
498 * Appearance
499 *****************************************************************************/
561
584 int* pPageNumber);
606 const int* pPageNumber);
656 const double* pTop);
682 double* pRight);
707 const double* pRight);
733 double* pBottom);
758 const double* pBottom);
784 double* pLeft);
809 const double* pLeft);
827
828/******************************************************************************
829 * SignatureConfiguration
830 *****************************************************************************/
865 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
900 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
929 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szFieldName);
958 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szFieldName);
1007 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, TPdfToolsSign_Appearance* pAppearance);
1032 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1057 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1084 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1111 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1132 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szLocation);
1153 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szLocation);
1178 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1203 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1222 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szReason);
1241 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szReason);
1270 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1299 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1322 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szContactInfo);
1345 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szContactInfo);
1346
1362/******************************************************************************
1363 * TimestampConfiguration
1364 *****************************************************************************/
1399 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, char* pBuffer, size_t nBufferSize);
1434 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1463 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, const char* szFieldName);
1492 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, const WCHAR* szFieldName);
1547 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, TPdfToolsSign_Appearance* pAppearance);
1548
1564/******************************************************************************
1565 * OutputOptions
1566 *****************************************************************************/
1576
1617 TPdfToolsSign_OutputOptions* pOutputOptions, TPdfToolsSign_SignatureRemoval iRemoveSignatures);
1716 TPdfToolsSign_OutputOptions* pOutputOptions, TPdfToolsSign_AddValidationInformation iAddValidationInformation);
1717
1718/******************************************************************************
1719 * MdpPermissionOptions
1720 *****************************************************************************/
1733
1764 TPdfToolsSign_MdpPermissionOptions* pMdpPermissionOptions, TPdfToolsPdf_MdpPermissions iPermissions);
1765
1766/******************************************************************************
1767 * SignatureFieldOptions
1768 *****************************************************************************/
1785
1833 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, char* pBuffer, size_t nBufferSize);
1860 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, WCHAR* pBuffer, size_t nBufferSize);
1881 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, const char* szFieldName);
1902 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, const WCHAR* szFieldName);
1903
1904/******************************************************************************
1905 * PreparedDocument
1906 *****************************************************************************/
1928 TPdfToolsSign_PreparedDocument* pPreparedDocument, TPdfToolsCrypto_HashAlgorithm iAlgorithm, unsigned char* pBuffer,
1929 size_t nBufferSize);
1930
1931/******************************************************************************
1932 * Signer
1933 *****************************************************************************/
1975 void* pContext,
1990 void* pContext,
1992
2002
2068 const TPdfToolsSys_StreamDescriptor* pStreamDesc, TPdfToolsSign_OutputOptions* pOutputOptions);
2128 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2129 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2187 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2188 TPdfToolsSign_TimestampConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2189 TPdfToolsSign_OutputOptions* pOutputOptions);
2227 const TPdfToolsSys_StreamDescriptor* pStreamDesc, TPdfToolsSign_OutputOptions* pOutputOptions);
2274 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2275 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2276 TPdfToolsSign_OutputOptions* pOutputOptions);
2321 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2322 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc);
2365 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2367
2368#ifdef __cplusplus
2369}
2370#endif
2371
2372#endif /* PDFTOOLS_PDFTOOLSSIGN_H__ */
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetFieldNameA(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration, char *pBuffer, size_t nBufferSize)
The name of the existing signature field.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_Process(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_OutputOptions *pOutputOptions, TPdfToolsCryptoProviders_Provider *pProvider)
Process a document.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetAppearance(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, TPdfToolsSign_Appearance *pAppearance)
The visual appearance of the signature.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetNext(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it)
Get the position of the next entry in the map.
PDFTOOLS_EXPORT TPdfToolsSign_CustomTextVariableMap *PDFTOOLS_CALL PdfToolsSign_Appearance_GetCustomTextVariables(TPdfToolsSign_Appearance *pAppearance)
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetAppearance(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration)
The visual appearance of the signature.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetEnd(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap)
Get the end position of the map.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_SignPreparedSignature(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_SignatureConfiguration *pConfiguration, const TPdfToolsSys_StreamDescriptor *pStreamDesc)
Sign a prepared signature Sign a document that contains a prepared signature created using PdfToolsSi...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetBottom(TPdfToolsSign_Appearance *pAppearance, const double *pBottom)
Distance to bottom of page.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetAppearance(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration, TPdfToolsSign_Appearance *pAppearance)
The visual appearance of the time-stamp.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetW(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, const WCHAR *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetAppearance(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration)
The visual appearance of the time-stamp.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetFieldNameA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const char *szFieldName)
The name of the existing signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetLeft(TPdfToolsSign_Appearance *pAppearance, const double *pLeft)
Distance to left of page.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetFieldNameW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The name of the existing signature field.
PDFTOOLS_EXPORT TPdfToolsSign_SignatureRemoval PDFTOOLS_CALL PdfToolsSign_OutputOptions_GetRemoveSignatures(TPdfToolsSign_OutputOptions *pOutputOptions)
Whether to remove any signatures.
void(PDFTOOLS_CALL * TPdfToolsSign_Signer_WarningA)(void *pContext, const char *szMessage, TPdfToolsSign_WarningCategory iCategory, const char *szContext)
Event for non-critical errors occurring during signature processing.
Definition PdfTools_PdfToolsSign.h:108
PDFTOOLS_EXPORT TPdfToolsPdf_MdpPermissions PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_GetPermissions(TPdfToolsSign_MdpPermissionOptions *pMdpPermissionOptions)
The access permissions granted for the document.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetContactInfoA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const char *szContactInfo)
The contact information of the signer Information provided by the signer to enable a recipient to con...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetReasonW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The reason for signing.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_SetValueW(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, const WCHAR *szValue)
Set the value of the entry at a position in the map.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetRight(TPdfToolsSign_Appearance *pAppearance, const double *pRight)
Distance to right of page.
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_Appearance_CreateFromJson(const TPdfToolsSys_StreamDescriptor *pStreamDesc)
Create an appearance with the content loaded from a JSON file The format of the JSON file is describe...
PDFTOOLS_EXPORT TPdfToolsSign_TimestampConfigurationType PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetType(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration)
Get actual derived type of base type TPdfToolsSign_TimestampConfiguration.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetContactInfoW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const WCHAR *szContactInfo)
The contact information of the signer Information provided by the signer to enable a recipient to con...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetLocationA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, char *pBuffer, size_t nBufferSize)
The location of signing The CPU host name or physical location of the signing.
PDFTOOLS_EXPORT TPdfToolsSign_AddValidationInformation PDFTOOLS_CALL PdfToolsSign_OutputOptions_GetAddValidationInformation(TPdfToolsSign_OutputOptions *pOutputOptions)
Add validation information to existing signatures of input document.
PDFTOOLS_EXPORT TPdfToolsSign_PreparedDocument *PDFTOOLS_CALL PdfToolsSign_Signer_AddPreparedSignature(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_SignatureConfiguration *pConfiguration, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_OutputOptions *pOutputOptions)
Add a prepared signature.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetKeyA(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, char *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_RemoveWarningHandlerA(TPdfToolsSign_Signer *pSigner, void *pContext, TPdfToolsSign_Signer_WarningA pFunction)
Removes event handler.
PDFTOOLS_EXPORT TPdfToolsSign_SignatureFieldOptions *PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_New(TPdfToolsSign_Appearance *pBoundingBox)
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetA(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, const char *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetSize(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap)
The number of key-value pairs in the map.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetBegin(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap)
Get the position of the first entry in the map.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetLeft(TPdfToolsSign_Appearance *pAppearance, double *pLeft)
Distance to left of page.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_SetValueA(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, const char *szValue)
Set the value of the entry at a position in the map.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetFieldNameW(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration, const WCHAR *szFieldName)
The name of the existing signature field.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_Certify(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_SignatureConfiguration *pConfiguration, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_MdpPermissionOptions *pPermissions, TPdfToolsSign_OutputOptions *pOutputOptions)
Add a document certification signature.
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetBoundingBox(TPdfToolsSign_SignatureFieldOptions *pSignatureFieldOptions)
The bounding box of the signature field.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetValueW(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetRight(TPdfToolsSign_Appearance *pAppearance, double *pRight)
Distance to right of page.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetBottom(TPdfToolsSign_Appearance *pAppearance, double *pBottom)
Distance to bottom of page.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_Sign(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_SignatureConfiguration *pConfiguration, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_OutputOptions *pOutputOptions)
Add a document signature.
PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetCount(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap)
The number of key-value pairs in the map.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_AddWarningHandlerA(TPdfToolsSign_Signer *pSigner, void *pContext, TPdfToolsSign_Signer_WarningA pFunction)
Adds event handler.
void(PDFTOOLS_CALL * TPdfToolsSign_Signer_WarningW)(void *pContext, const WCHAR *szMessage, TPdfToolsSign_WarningCategory iCategory, const WCHAR *szContext)
Event for non-critical errors occurring during signature processing.
Definition PdfTools_PdfToolsSign.h:123
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_OutputOptions_SetRemoveSignatures(TPdfToolsSign_OutputOptions *pOutputOptions, TPdfToolsSign_SignatureRemoval iRemoveSignatures)
Whether to remove any signatures.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetContactInfoW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The contact information of the signer Information provided by the signer to enable a recipient to con...
PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfigurationType PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetType(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration)
Get actual derived type of base type TPdfToolsSign_SignatureConfiguration.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetValueA(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, char *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_PreparedDocument_GetHash(TPdfToolsSign_PreparedDocument *pPreparedDocument, TPdfToolsCrypto_HashAlgorithm iAlgorithm, unsigned char *pBuffer, size_t nBufferSize)
Calculate the hash value Calculate the hash value to create the signature from.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetNameW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The name of the signing certificate.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetFieldNameW(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The name of the existing signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_Remove(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it)
Remove the entry at a position in the map.
PDFTOOLS_EXPORT TPdfToolsSign_Signer *PDFTOOLS_CALL PdfToolsSign_Signer_New(void)
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetLocationW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, WCHAR *pBuffer, size_t nBufferSize)
The location of signing The CPU host name or physical location of the signing.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_OutputOptions_SetAddValidationInformation(TPdfToolsSign_OutputOptions *pOutputOptions, TPdfToolsSign_AddValidationInformation iAddValidationInformation)
Add validation information to existing signatures of input document.
PDFTOOLS_EXPORT TPdfToolsSign_MdpPermissionOptions *PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_New(TPdfToolsPdf_MdpPermissions iPermissions)
PDFTOOLS_EXPORT TPdfToolsSign_OutputOptions *PDFTOOLS_CALL PdfToolsSign_OutputOptions_New(void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_SetFieldNameW(TPdfToolsSign_SignatureFieldOptions *pSignatureFieldOptions, const WCHAR *szFieldName)
The name of the new signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetReasonW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const WCHAR *szReason)
The reason for signing.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetNameA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, char *pBuffer, size_t nBufferSize)
The name of the signing certificate.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetReasonA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const char *szReason)
The reason for signing.
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_Appearance_CreateFromXml(const TPdfToolsSys_StreamDescriptor *pStreamDesc)
Create an appearance with the content loaded from an XML file The format of the XML file is described...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetFieldNameA(TPdfToolsSign_SignatureFieldOptions *pSignatureFieldOptions, char *pBuffer, size_t nBufferSize)
The name of the new signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetLocationW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const WCHAR *szLocation)
The location of signing The CPU host name or physical location of the signing.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_Clear(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap)
Remove all entries from the map.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetContactInfoA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, char *pBuffer, size_t nBufferSize)
The contact information of the signer Information provided by the signer to enable a recipient to con...
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetReasonA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, char *pBuffer, size_t nBufferSize)
The reason for signing.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_SetFieldNameA(TPdfToolsSign_SignatureFieldOptions *pSignatureFieldOptions, const char *szFieldName)
The name of the new signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_SetW(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, const WCHAR *szKey, const WCHAR *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
#define PDFTOOLS_CALL
Definition PdfTools_PdfToolsSign.h:26
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetFieldNameW(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const WCHAR *szFieldName)
The name of the existing signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_RemoveWarningHandlerW(TPdfToolsSign_Signer *pSigner, void *pContext, TPdfToolsSign_Signer_WarningW pFunction)
Removes event handler.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetFieldNameA(TPdfToolsSign_TimestampConfiguration *pTimestampConfiguration, const char *szFieldName)
The name of the existing signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetTop(TPdfToolsSign_Appearance *pAppearance, const double *pTop)
Distance to top of page.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetTop(TPdfToolsSign_Appearance *pAppearance, double *pTop)
Distance to top of page.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetLocationA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, const char *szLocation)
The location of signing The CPU host name or physical location of the signing.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_AddSignatureField(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_SignatureFieldOptions *pOptions, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_OutputOptions *pOutputOptions)
Add an unsigned signature field.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_SetA(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, const char *szKey, const char *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_AddWarningHandlerW(TPdfToolsSign_Signer *pSigner, void *pContext, TPdfToolsSign_Signer_WarningW pFunction)
Adds event handler.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetKeyW(TPdfToolsSign_CustomTextVariableMap *pCustomTextVariableMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsSign_Signer_AddTimestamp(TPdfToolsSign_Signer *pSigner, TPdfToolsPdf_Document *pDocument, TPdfToolsSign_TimestampConfiguration *pConfiguration, const TPdfToolsSys_StreamDescriptor *pStreamDesc, TPdfToolsSign_OutputOptions *pOutputOptions)
Add a document time-stamp.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_SetPermissions(TPdfToolsSign_MdpPermissionOptions *pMdpPermissionOptions, TPdfToolsPdf_MdpPermissions iPermissions)
The access permissions granted for the document.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetPageNumber(TPdfToolsSign_Appearance *pAppearance, const int *pPageNumber)
The number of the page where the appearance is positioned.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetFieldNameA(TPdfToolsSign_SignatureConfiguration *pSignatureConfiguration, char *pBuffer, size_t nBufferSize)
The name of the existing signature field.
PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_Appearance_CreateFieldBoundingBox(const TPdfToolsGeomUnits_Size *pSize)
Create the bounding box for an unsigned signature field Unsigned signature fields can define a rectan...
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetPageNumber(TPdfToolsSign_Appearance *pAppearance, int *pPageNumber)
The number of the page where the appearance is positioned.
PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetFieldNameW(TPdfToolsSign_SignatureFieldOptions *pSignatureFieldOptions, WCHAR *pBuffer, size_t nBufferSize)
The name of the new signature field.
#define PDFTOOLS_EXPORT
Definition PdfTools_Platform.h:143
unsigned short WCHAR
Definition PdfTools_Platform.h:95
TPdfToolsSign_SignatureRemoval
Definition PdfTools_Types.h:1234
TPdfToolsSign_WarningCategory
The warning category The category of the warning of TPdfToolsSign_Signer_Warning.
Definition PdfTools_Types.h:1184
TPdfToolsSign_TimestampConfigurationType
Type and subtype enumeration of TPdfToolsSign_TimestampConfiguration.
Definition PdfTools_Types.h:2097
TPdfToolsPdf_MdpPermissions
Definition PdfTools_Types.h:173
TPdfToolsSign_SignatureConfigurationType
Type and subtype enumeration of TPdfToolsSign_SignatureConfiguration.
Definition PdfTools_Types.h:2072
#define BOOL
Definition PdfTools_Types.h:23
TPdfToolsSign_AddValidationInformation
Definition PdfTools_Types.h:1260
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1281
Base class for cryptographic providers.
The PDF document PDF documents are either opened using PdfToolsPdf_Document_Open or the result of an ...
The visual appearance of signatures.
The permission options when certifying a document.
Additional document level options.
A document that has been prepared for signing.
Configuration for signature creation.
Options for adding unsigned signature fields These options control the creation of unsigned signature...
Process signatures and signature fields.
Configuration for adding time-stamps.
Definition PdfTools_Types.h:3328
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:49