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 *****************************************************************************/
13
14#ifndef PDFTOOLS_PDFTOOLSSIGN_H__
15#define PDFTOOLS_PDFTOOLSSIGN_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 PdfToolsSign_CustomTextVariableMap_Get PdfToolsSign_CustomTextVariableMap_GetW
35#define PdfToolsSign_CustomTextVariableMap_GetKey PdfToolsSign_CustomTextVariableMap_GetKeyW
36#define PdfToolsSign_CustomTextVariableMap_GetValue PdfToolsSign_CustomTextVariableMap_GetValueW
37#define PdfToolsSign_CustomTextVariableMap_Set PdfToolsSign_CustomTextVariableMap_SetW
38#define PdfToolsSign_CustomTextVariableMap_SetValue PdfToolsSign_CustomTextVariableMap_SetValueW
39
40#define PdfToolsSign_SignatureConfiguration_GetFieldName PdfToolsSign_SignatureConfiguration_GetFieldNameW
41#define PdfToolsSign_SignatureConfiguration_SetFieldName PdfToolsSign_SignatureConfiguration_SetFieldNameW
42#define PdfToolsSign_SignatureConfiguration_GetName PdfToolsSign_SignatureConfiguration_GetNameW
43
44#define PdfToolsSign_SignatureConfiguration_GetLocation PdfToolsSign_SignatureConfiguration_GetLocationW
45#define PdfToolsSign_SignatureConfiguration_SetLocation PdfToolsSign_SignatureConfiguration_SetLocationW
46#define PdfToolsSign_SignatureConfiguration_GetReason PdfToolsSign_SignatureConfiguration_GetReasonW
47#define PdfToolsSign_SignatureConfiguration_SetReason PdfToolsSign_SignatureConfiguration_SetReasonW
48#define PdfToolsSign_SignatureConfiguration_GetContactInfo PdfToolsSign_SignatureConfiguration_GetContactInfoW
49#define PdfToolsSign_SignatureConfiguration_SetContactInfo PdfToolsSign_SignatureConfiguration_SetContactInfoW
50
51#define PdfToolsSign_TimestampConfiguration_GetFieldName PdfToolsSign_TimestampConfiguration_GetFieldNameW
52#define PdfToolsSign_TimestampConfiguration_SetFieldName PdfToolsSign_TimestampConfiguration_SetFieldNameW
53
54#define PdfToolsSign_SignatureFieldOptions_GetFieldName PdfToolsSign_SignatureFieldOptions_GetFieldNameW
55#define PdfToolsSign_SignatureFieldOptions_SetFieldName PdfToolsSign_SignatureFieldOptions_SetFieldNameW
56
57#define TPdfToolsSign_Signer_Warning TPdfToolsSign_Signer_WarningW
58#define PdfToolsSign_Signer_AddWarningHandler PdfToolsSign_Signer_AddWarningHandlerW
59#define PdfToolsSign_Signer_RemoveWarningHandler PdfToolsSign_Signer_RemoveWarningHandlerW
60
61#else
62#define PdfToolsSign_CustomTextVariableMap_Get PdfToolsSign_CustomTextVariableMap_GetA
63#define PdfToolsSign_CustomTextVariableMap_GetKey PdfToolsSign_CustomTextVariableMap_GetKeyA
64#define PdfToolsSign_CustomTextVariableMap_GetValue PdfToolsSign_CustomTextVariableMap_GetValueA
65#define PdfToolsSign_CustomTextVariableMap_Set PdfToolsSign_CustomTextVariableMap_SetA
66#define PdfToolsSign_CustomTextVariableMap_SetValue PdfToolsSign_CustomTextVariableMap_SetValueA
67
68#define PdfToolsSign_SignatureConfiguration_GetFieldName PdfToolsSign_SignatureConfiguration_GetFieldNameA
69#define PdfToolsSign_SignatureConfiguration_SetFieldName PdfToolsSign_SignatureConfiguration_SetFieldNameA
70#define PdfToolsSign_SignatureConfiguration_GetName PdfToolsSign_SignatureConfiguration_GetNameA
71
72#define PdfToolsSign_SignatureConfiguration_GetLocation PdfToolsSign_SignatureConfiguration_GetLocationA
73#define PdfToolsSign_SignatureConfiguration_SetLocation PdfToolsSign_SignatureConfiguration_SetLocationA
74#define PdfToolsSign_SignatureConfiguration_GetReason PdfToolsSign_SignatureConfiguration_GetReasonA
75#define PdfToolsSign_SignatureConfiguration_SetReason PdfToolsSign_SignatureConfiguration_SetReasonA
76#define PdfToolsSign_SignatureConfiguration_GetContactInfo PdfToolsSign_SignatureConfiguration_GetContactInfoA
77#define PdfToolsSign_SignatureConfiguration_SetContactInfo PdfToolsSign_SignatureConfiguration_SetContactInfoA
78
79#define PdfToolsSign_TimestampConfiguration_GetFieldName PdfToolsSign_TimestampConfiguration_GetFieldNameA
80#define PdfToolsSign_TimestampConfiguration_SetFieldName PdfToolsSign_TimestampConfiguration_SetFieldNameA
81
82#define PdfToolsSign_SignatureFieldOptions_GetFieldName PdfToolsSign_SignatureFieldOptions_GetFieldNameA
83#define PdfToolsSign_SignatureFieldOptions_SetFieldName PdfToolsSign_SignatureFieldOptions_SetFieldNameA
84
85#define TPdfToolsSign_Signer_Warning TPdfToolsSign_Signer_WarningA
86#define PdfToolsSign_Signer_AddWarningHandler PdfToolsSign_Signer_AddWarningHandlerA
87#define PdfToolsSign_Signer_RemoveWarningHandler PdfToolsSign_Signer_RemoveWarningHandlerA
88
89#endif
90
103typedef void(PDFTOOLS_CALL* TPdfToolsSign_Signer_WarningA)(void* pContext, const char* szMessage,
105 const char* szContext);
118typedef void(PDFTOOLS_CALL* TPdfToolsSign_Signer_WarningW)(void* pContext, const WCHAR* szMessage,
120 const WCHAR* szContext);
121
122/******************************************************************************
123 * CustomTextVariableMap
124 *****************************************************************************/
278 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const WCHAR* szKey);
303 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, char* pBuffer, size_t nBufferSize);
328 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, WCHAR* pBuffer, size_t nBufferSize);
353 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, char* pBuffer, size_t nBufferSize);
378 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, WCHAR* pBuffer, size_t nBufferSize);
402 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const char* szKey, const char* szValue);
426 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, const WCHAR* szKey, const WCHAR* szValue);
446 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, const char* szValue);
466 TPdfToolsSign_CustomTextVariableMap* pCustomTextVariableMap, int it, const WCHAR* szValue);
503
504/******************************************************************************
505 * Appearance
506 *****************************************************************************/
571
594 int* pPageNumber);
616 const int* pPageNumber);
666 const double* pTop);
692 double* pRight);
717 const double* pRight);
743 double* pBottom);
768 const double* pBottom);
794 double* pLeft);
819 const double* pLeft);
838
839/******************************************************************************
840 * SignatureConfiguration
841 *****************************************************************************/
876 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
911 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
940 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szFieldName);
969 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szFieldName);
1018 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, TPdfToolsSign_Appearance* pAppearance);
1043 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1068 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1095 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1122 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1143 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szLocation);
1164 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szLocation);
1189 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1214 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1233 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szReason);
1252 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szReason);
1281 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, char* pBuffer, size_t nBufferSize);
1310 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1333 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const char* szContactInfo);
1356 TPdfToolsSign_SignatureConfiguration* pSignatureConfiguration, const WCHAR* szContactInfo);
1357
1373/******************************************************************************
1374 * TimestampConfiguration
1375 *****************************************************************************/
1410 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, char* pBuffer, size_t nBufferSize);
1445 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, WCHAR* pBuffer, size_t nBufferSize);
1474 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, const char* szFieldName);
1503 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, const WCHAR* szFieldName);
1558 TPdfToolsSign_TimestampConfiguration* pTimestampConfiguration, TPdfToolsSign_Appearance* pAppearance);
1559
1575/******************************************************************************
1576 * OutputOptions
1577 *****************************************************************************/
1588
1630 TPdfToolsSign_OutputOptions* pOutputOptions, TPdfToolsSign_SignatureRemoval iRemoveSignatures);
1730 TPdfToolsSign_OutputOptions* pOutputOptions, TPdfToolsSign_AddValidationInformation iAddValidationInformation);
1731
1732/******************************************************************************
1733 * MdpPermissionOptions
1734 *****************************************************************************/
1748
1780 TPdfToolsSign_MdpPermissionOptions* pMdpPermissionOptions, TPdfToolsPdf_MdpPermissions iPermissions);
1781
1782/******************************************************************************
1783 * SignatureFieldOptions
1784 *****************************************************************************/
1802
1851 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, char* pBuffer, size_t nBufferSize);
1878 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, WCHAR* pBuffer, size_t nBufferSize);
1899 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, const char* szFieldName);
1920 TPdfToolsSign_SignatureFieldOptions* pSignatureFieldOptions, const WCHAR* szFieldName);
1921
1922/******************************************************************************
1923 * PreparedDocument
1924 *****************************************************************************/
1947 TPdfToolsSign_PreparedDocument* pPreparedDocument, TPdfToolsCrypto_HashAlgorithm iAlgorithm, unsigned char* pBuffer,
1948 size_t nBufferSize);
1949
1950/******************************************************************************
1951 * Signer
1952 *****************************************************************************/
1994 void* pContext,
2009 void* pContext,
2011
2022
2089 const TPdfToolsSys_StreamDescriptor* pStreamDesc, TPdfToolsSign_OutputOptions* pOutputOptions);
2150 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2151 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2210 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2211 TPdfToolsSign_TimestampConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2212 TPdfToolsSign_OutputOptions* pOutputOptions);
2251 const TPdfToolsSys_StreamDescriptor* pStreamDesc, TPdfToolsSign_OutputOptions* pOutputOptions);
2299 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2300 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2301 TPdfToolsSign_OutputOptions* pOutputOptions);
2347 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument,
2348 TPdfToolsSign_SignatureConfiguration* pConfiguration, const TPdfToolsSys_StreamDescriptor* pStreamDesc);
2392 TPdfToolsSign_Signer* pSigner, TPdfToolsPdf_Document* pDocument, const TPdfToolsSys_StreamDescriptor* pStreamDesc,
2394
2395#ifdef __cplusplus
2396}
2397#endif
2398
2399#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:103
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:118
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:21
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:138
unsigned short WCHAR
Definition PdfTools_Platform.h:90
TPdfToolsSign_SignatureRemoval
Definition PdfTools_Types.h:1164
struct TPdfToolsSign_MdpPermissionOptions TPdfToolsSign_MdpPermissionOptions
The permission options when certifying a document.
Definition PdfTools_Types.h:2825
TPdfToolsSign_WarningCategory
The warning category The category of the warning of TPdfToolsSign_Signer_Warning.
Definition PdfTools_Types.h:1114
struct TPdfToolsCryptoProviders_Provider TPdfToolsCryptoProviders_Provider
Base class for cryptographic providers.
Definition PdfTools_Types.h:2866
struct TPdfToolsSign_PreparedDocument TPdfToolsSign_PreparedDocument
A document that has been prepared for signing.
Definition PdfTools_Types.h:2835
struct TPdfToolsSign_SignatureFieldOptions TPdfToolsSign_SignatureFieldOptions
Options for adding unsigned signature fields These options control the creation of unsigned signature...
Definition PdfTools_Types.h:2831
TPdfToolsSign_TimestampConfigurationType
Type and subtype enumeration of TPdfToolsSign_TimestampConfiguration.
Definition PdfTools_Types.h:2030
struct TPdfToolsSign_Signer TPdfToolsSign_Signer
Process signatures and signature fields.
Definition PdfTools_Types.h:2839
struct TPdfToolsSign_SignatureConfiguration TPdfToolsSign_SignatureConfiguration
Configuration for signature creation.
Definition PdfTools_Types.h:2794
struct TPdfToolsSign_OutputOptions TPdfToolsSign_OutputOptions
Additional document level options.
Definition PdfTools_Types.h:2821
struct TPdfToolsSign_CustomTextVariableMap TPdfToolsSign_CustomTextVariableMap
Definition PdfTools_Types.h:2759
TPdfToolsPdf_MdpPermissions
Definition PdfTools_Types.h:168
TPdfToolsSign_SignatureConfigurationType
Type and subtype enumeration of TPdfToolsSign_SignatureConfiguration.
Definition PdfTools_Types.h:2005
#define BOOL
Definition PdfTools_Types.h:18
TPdfToolsSign_AddValidationInformation
Definition PdfTools_Types.h:1190
struct TPdfToolsSign_Appearance TPdfToolsSign_Appearance
The visual appearance of signatures.
Definition PdfTools_Types.h:2782
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
struct TPdfToolsSign_TimestampConfiguration TPdfToolsSign_TimestampConfiguration
Configuration for adding time-stamps.
Definition PdfTools_Types.h:2805
TPdfToolsCrypto_HashAlgorithm
Definition PdfTools_Types.h:1211
Definition PdfTools_Types.h:3138
Structure that groups a set of callbacks that model streams.
Definition PdfTools_PdfToolsSys.h:44