|
Pdftools SDK
|
Go to the source code of this file.
Typedefs | |
| typedef 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. | |
| typedef 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. | |
| #define PDFTOOLS_CALL |
| #define PdfToolsSign_CustomTextVariableMap_Get PdfToolsSign_CustomTextVariableMap_GetA |
| #define PdfToolsSign_CustomTextVariableMap_GetKey PdfToolsSign_CustomTextVariableMap_GetKeyA |
| #define PdfToolsSign_CustomTextVariableMap_GetValue PdfToolsSign_CustomTextVariableMap_GetValueA |
| #define PdfToolsSign_CustomTextVariableMap_Set PdfToolsSign_CustomTextVariableMap_SetA |
| #define PdfToolsSign_CustomTextVariableMap_SetValue PdfToolsSign_CustomTextVariableMap_SetValueA |
| #define PdfToolsSign_SignatureConfiguration_GetContactInfo PdfToolsSign_SignatureConfiguration_GetContactInfoA |
| #define PdfToolsSign_SignatureConfiguration_GetFieldName PdfToolsSign_SignatureConfiguration_GetFieldNameA |
| #define PdfToolsSign_SignatureConfiguration_GetLocation PdfToolsSign_SignatureConfiguration_GetLocationA |
| #define PdfToolsSign_SignatureConfiguration_GetName PdfToolsSign_SignatureConfiguration_GetNameA |
| #define PdfToolsSign_SignatureConfiguration_GetReason PdfToolsSign_SignatureConfiguration_GetReasonA |
| #define PdfToolsSign_SignatureConfiguration_SetContactInfo PdfToolsSign_SignatureConfiguration_SetContactInfoA |
| #define PdfToolsSign_SignatureConfiguration_SetFieldName PdfToolsSign_SignatureConfiguration_SetFieldNameA |
| #define PdfToolsSign_SignatureConfiguration_SetLocation PdfToolsSign_SignatureConfiguration_SetLocationA |
| #define PdfToolsSign_SignatureConfiguration_SetReason PdfToolsSign_SignatureConfiguration_SetReasonA |
| #define PdfToolsSign_SignatureFieldOptions_GetFieldName PdfToolsSign_SignatureFieldOptions_GetFieldNameA |
| #define PdfToolsSign_SignatureFieldOptions_SetFieldName PdfToolsSign_SignatureFieldOptions_SetFieldNameA |
| #define PdfToolsSign_Signer_AddWarningHandler PdfToolsSign_Signer_AddWarningHandlerA |
| #define PdfToolsSign_Signer_RemoveWarningHandler PdfToolsSign_Signer_RemoveWarningHandlerA |
| #define PdfToolsSign_TimestampConfiguration_GetFieldName PdfToolsSign_TimestampConfiguration_GetFieldNameA |
| #define PdfToolsSign_TimestampConfiguration_SetFieldName PdfToolsSign_TimestampConfiguration_SetFieldNameA |
| #define TPdfToolsSign_Signer_Warning TPdfToolsSign_Signer_WarningA |
| typedef 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.
| [in,out] | pContext | Context of the event callback. |
| [in] | szMessage | The message describing the warning |
| [in] | iCategory | The category of the warning |
| [in] | szContext | A description of the context where the warning occurred |
| typedef 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.
| [in,out] | pContext | Context of the event callback. |
| [in] | szMessage | The message describing the warning |
| [in] | iCategory | The category of the warning |
| [in] | szContext | A description of the context where the warning occurred |
| 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 rectangle on a page. When the field is signed, the signer creates a visual appearance within that rectangle.
| [in] | pSize | The size of the rectangle |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | 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 described in the user manual.
| [in] | pStreamDesc | The JSON file defining the content |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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 in the user manual.
| [in] | pStreamDesc | The XML file defining the content |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetBottom | ( | TPdfToolsSign_Appearance * | pAppearance, |
| double * | pBottom ) |
Distance to bottom of page.
This property specifies the distance between appearance's bottom edge and the bottom of the page.
If NULL, the distance to the bottom is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [out] | pBottom | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_EXPORT TPdfToolsSign_CustomTextVariableMap *PDFTOOLS_CALL PdfToolsSign_Appearance_GetCustomTextVariables | ( | TPdfToolsSign_Appearance * | pAppearance | ) |
Maps the name of a custom text variable to its value. These variables can parametrize the content of the text element in the appearance configuration XML and Json files. They are used by setting "[custom:‹key›]".
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetLeft | ( | TPdfToolsSign_Appearance * | pAppearance, |
| double * | pLeft ) |
Distance to left of page.
This property specifies the distance between appearance's left edge and the left of the page.
If NULL, the distance to the left is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [out] | pLeft | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetPageNumber | ( | TPdfToolsSign_Appearance * | pAppearance, |
| int * | pPageNumber ) |
The number of the page where the appearance is positioned.
Page number must be in the range from 1 to PdfToolsPdf_Document_GetPageCount.
If NULL, the appearance is positioned on the last page.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [out] | pPageNumber | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetRight | ( | TPdfToolsSign_Appearance * | pAppearance, |
| double * | pRight ) |
Distance to right of page.
This property specifies the distance between appearance's right edge and the right of the page.
If NULL, the distance to the right is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [out] | pRight | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_GetTop | ( | TPdfToolsSign_Appearance * | pAppearance, |
| double * | pTop ) |
Distance to top of page.
This property specifies the distance between appearance's top edge and the top of the page.
If NULL, the distance to the top is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [out] | pTop | Retrieved value. |
[out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetBottom | ( | TPdfToolsSign_Appearance * | pAppearance, |
| const double * | pBottom ) |
Distance to bottom of page.
This property specifies the distance between appearance's bottom edge and the bottom of the page.
If NULL, the distance to the bottom is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [in] | pBottom | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetLeft | ( | TPdfToolsSign_Appearance * | pAppearance, |
| const double * | pLeft ) |
Distance to left of page.
This property specifies the distance between appearance's left edge and the left of the page.
If NULL, the distance to the left is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [in] | pLeft | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetPageNumber | ( | TPdfToolsSign_Appearance * | pAppearance, |
| const int * | pPageNumber ) |
The number of the page where the appearance is positioned.
Page number must be in the range from 1 to PdfToolsPdf_Document_GetPageCount.
If NULL, the appearance is positioned on the last page.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [in] | pPageNumber | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetRight | ( | TPdfToolsSign_Appearance * | pAppearance, |
| const double * | pRight ) |
Distance to right of page.
This property specifies the distance between appearance's right edge and the right of the page.
If NULL, the distance to the right is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [in] | pRight | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Appearance_SetTop | ( | TPdfToolsSign_Appearance * | pAppearance, |
| const double * | pTop ) |
Distance to top of page.
This property specifies the distance between appearance's top edge and the top of the page.
If NULL, the distance to the top is unspecified.
Default: NULL
| [in,out] | pAppearance | Acts as a handle to the native object of type TPdfToolsSign_Appearance. |
| [in] | pTop | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_Clear | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap | ) |
Remove all entries from the map.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| 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 corresponding value with PdfToolsSign_CustomTextVariableMap_GetValue.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | szKey |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetBegin | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap | ) |
Get the position of the first entry in the map.
The order of the entries is arbitrary and not significant.
If the returned position differs from PdfToolsSign_CustomTextVariableMap_GetEnd,then the position can be used to retrieve the map entry with PdfToolsSign_CustomTextVariableMap_GetKey, PdfToolsSign_CustomTextVariableMap_GetValue.
Use PdfToolsSign_CustomTextVariableMap_GetNext to get the position of the next entry.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetCount | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap | ) |
The number of key-value pairs in the map.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetEnd | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap | ) |
Get the end position of the map.
This position does not correspond to an actual entry in the map.
It must be used to determine whether the end of the map has been reached when using PdfToolsSign_CustomTextVariableMap_GetBegin and PdfToolsSign_CustomTextVariableMap_GetNext.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [out] | pBuffer | To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if there is an error. 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [out] | pBuffer | To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if there is an error. 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetNext | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap, |
| int | it ) |
Get the position of the next entry in the map.
The order of the entries is arbitrary and not significant.
If the returned position differs from PdfToolsSign_CustomTextVariableMap_GetEnd, then the position can be used to retrieve the map entry with PdfToolsSign_CustomTextVariableMap_GetKey and PdfToolsSign_CustomTextVariableMap_GetValue.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_GetSize | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap | ) |
The number of key-value pairs in the map.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [out] | pBuffer | To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if there is an error. 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [out] | pBuffer | To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if there is an error. 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| 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 corresponding value with PdfToolsSign_CustomTextVariableMap_GetValue.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | szKey |
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_CustomTextVariableMap_Remove | ( | TPdfToolsSign_CustomTextVariableMap * | pCustomTextVariableMap, |
| int | it ) |
Remove the entry at a position in the map.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it |
| 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 returned by‹pre›_‹map›_GetBegin, PdfToolsSign_CustomTextVariableMap_GetEnd, PdfToolsSign_CustomTextVariableMap_GetNext, and PdfToolsSign_CustomTextVariableMap_Get.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | szKey | |
| [in] | szValue |
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [in] | szValue |
| 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.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | it | |
| [in] | szValue |
| 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 returned by‹pre›_‹map›_GetBegin, PdfToolsSign_CustomTextVariableMap_GetEnd, PdfToolsSign_CustomTextVariableMap_GetNext, and PdfToolsSign_CustomTextVariableMap_Get.
| [in,out] | pCustomTextVariableMap | Acts as a handle to the native object of type TPdfToolsSign_CustomTextVariableMap. |
| [in] | szKey | |
| [in] | szValue |
| PDFTOOLS_EXPORT TPdfToolsPdf_MdpPermissions PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_GetPermissions | ( | TPdfToolsSign_MdpPermissionOptions * | pMdpPermissionOptions | ) |
The access permissions granted for the document.
| [in,out] | pMdpPermissionOptions | Acts as a handle to the native object of type TPdfToolsSign_MdpPermissionOptions. |
May indicate an error in certain scenarios. For further information see the note section below.
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsSign_MdpPermissionOptions *PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_New | ( | TPdfToolsPdf_MdpPermissions | iPermissions | ) |
| [in] | iPermissions |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_MdpPermissionOptions_SetPermissions | ( | TPdfToolsSign_MdpPermissionOptions * | pMdpPermissionOptions, |
| TPdfToolsPdf_MdpPermissions | iPermissions ) |
The access permissions granted for the document.
| [in,out] | pMdpPermissionOptions | Acts as a handle to the native object of type TPdfToolsSign_MdpPermissionOptions. |
| [in] | iPermissions | Set value. |
| PDFTOOLS_EXPORT TPdfToolsSign_AddValidationInformation PDFTOOLS_CALL PdfToolsSign_OutputOptions_GetAddValidationInformation | ( | TPdfToolsSign_OutputOptions * | pOutputOptions | ) |
Add validation information to existing signatures of input document.
Add signature validation information to the document security store (DSS). This information includes:
Validation information for embedded time-stamp tokens is added as well.
If adding validation information fails, an TPdfToolsSign_Signer_Warning with an ePdfToolsSign_WarningCategory_AddValidationInformationFailed is generated.
All types of cryptographic providers support this method. However, this method fails when using a provider whose certificate store is missing a required certificate.
Note: This property has no effect on any new signatures or time-stamp that may also be added. The validation information of signatures and time-stamps is controlled by the respective property in the signature or time-stamp configuration object.
Note: This method does not validate the signatures, but only downloads the information required.
Note: Adding validation information for expired certificates is not possible. Therefore, it is crucial to enlarge the longevity of signatures before they expire.
Note: Adding validation information to document certification (MDP) signatures is not possible, because it would break the signature. Validation information must be added to certification signatures when creating them.
Default: ePdfToolsSign_AddValidationInformation_None
| [in,out] | pOutputOptions | Acts as a handle to the native object of type TPdfToolsSign_OutputOptions. |
May indicate an error in certain scenarios. For further information see the note section below.
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsSign_SignatureRemoval PDFTOOLS_CALL PdfToolsSign_OutputOptions_GetRemoveSignatures | ( | TPdfToolsSign_OutputOptions * | pOutputOptions | ) |
Whether to remove any signatures.
By default, all signatures of the input document are preserved. Optionally, some or all of them can be removed.
Default: ePdfToolsSign_SignatureRemoval_None
| [in,out] | pOutputOptions | Acts as a handle to the native object of type TPdfToolsSign_OutputOptions. |
May indicate an error in certain scenarios. For further information see the note section below.
0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsSign_OutputOptions *PDFTOOLS_CALL PdfToolsSign_OutputOptions_New | ( | void | ) |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_OutputOptions_SetAddValidationInformation | ( | TPdfToolsSign_OutputOptions * | pOutputOptions, |
| TPdfToolsSign_AddValidationInformation | iAddValidationInformation ) |
Add validation information to existing signatures of input document.
Add signature validation information to the document security store (DSS). This information includes:
Validation information for embedded time-stamp tokens is added as well.
If adding validation information fails, an TPdfToolsSign_Signer_Warning with an ePdfToolsSign_WarningCategory_AddValidationInformationFailed is generated.
All types of cryptographic providers support this method. However, this method fails when using a provider whose certificate store is missing a required certificate.
Note: This property has no effect on any new signatures or time-stamp that may also be added. The validation information of signatures and time-stamps is controlled by the respective property in the signature or time-stamp configuration object.
Note: This method does not validate the signatures, but only downloads the information required.
Note: Adding validation information for expired certificates is not possible. Therefore, it is crucial to enlarge the longevity of signatures before they expire.
Note: Adding validation information to document certification (MDP) signatures is not possible, because it would break the signature. Validation information must be added to certification signatures when creating them.
Default: ePdfToolsSign_AddValidationInformation_None
| [in,out] | pOutputOptions | Acts as a handle to the native object of type TPdfToolsSign_OutputOptions. |
| [in] | iAddValidationInformation | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_OutputOptions_SetRemoveSignatures | ( | TPdfToolsSign_OutputOptions * | pOutputOptions, |
| TPdfToolsSign_SignatureRemoval | iRemoveSignatures ) |
Whether to remove any signatures.
By default, all signatures of the input document are preserved. Optionally, some or all of them can be removed.
Default: ePdfToolsSign_SignatureRemoval_None
| [in,out] | pOutputOptions | Acts as a handle to the native object of type TPdfToolsSign_OutputOptions. |
| [in] | iRemoveSignatures | Set value. |
| 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.
| [in,out] | pPreparedDocument | Acts as a handle to the native object of type TPdfToolsSign_PreparedDocument. |
| [in] | iAlgorithm | The hash algorithm |
| [out] | pBuffer | To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved array pBuffer. |
pBuffer. -1 if there is an error. 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetAppearance | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration | ) |
The visual appearance of the signature.
The visual appearance or NULL to create a signature without a visual appearance.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.
NULL is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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 contact the signer to verify the signature. For example, a phone number.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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 contact the signer to verify the signature. For example, a phone number.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetFieldNameA | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_SignatureConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetFieldNameW | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_SignatureConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetNameA | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the signing certificate.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetNameW | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the signing certificate.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetReasonA | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The reason for signing.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetReasonW | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The reason for signing.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsSign_SignatureConfigurationType PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_GetType | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration | ) |
Get actual derived type of base type TPdfToolsSign_SignatureConfiguration.
This function is invoked prior to downcasting to ascertain the derived object type.
| [in,out] | pSignatureConfiguration | Acts as a handle to a native object. |
0 in case of an error.0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetAppearance | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| TPdfToolsSign_Appearance * | pAppearance ) |
The visual appearance of the signature.
The visual appearance or NULL to create a signature without a visual appearance.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in,out] | pAppearance | Set value. |
| 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 contact the signer to verify the signature. For example, a phone number.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szContactInfo | Set value. |
| 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 contact the signer to verify the signature. For example, a phone number.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szContactInfo | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetFieldNameA | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| const char * | szFieldName ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_SignatureConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szFieldName | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetFieldNameW | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| const WCHAR * | szFieldName ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to sign. Note that when an existing signature field is signed, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_SignatureConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szFieldName | Set value. |
| 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.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szLocation | Set value. |
| 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.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szLocation | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetReasonA | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| const char * | szReason ) |
The reason for signing.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szReason | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureConfiguration_SetReasonW | ( | TPdfToolsSign_SignatureConfiguration * | pSignatureConfiguration, |
| const WCHAR * | szReason ) |
The reason for signing.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsSign_SignatureConfiguration. |
| [in] | szReason | Set value. |
| PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetBoundingBox | ( | TPdfToolsSign_SignatureFieldOptions * | pSignatureFieldOptions | ) |
The bounding box of the signature field.
The bounding box is the area where the visual appearance of the signature is inserted, when the signature field is signed.
Use PdfToolsSign_Appearance_CreateFieldBoundingBox to create the bounding box object.
| [in,out] | pSignatureFieldOptions | Acts as a handle to the native object of type TPdfToolsSign_SignatureFieldOptions. |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetFieldNameA | ( | TPdfToolsSign_SignatureFieldOptions * | pSignatureFieldOptions, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the new signature field.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureFieldOptions | Acts as a handle to the native object of type TPdfToolsSign_SignatureFieldOptions. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_GetFieldNameW | ( | TPdfToolsSign_SignatureFieldOptions * | pSignatureFieldOptions, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the new signature field.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureFieldOptions | Acts as a handle to the native object of type TPdfToolsSign_SignatureFieldOptions. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsSign_SignatureFieldOptions *PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_New | ( | TPdfToolsSign_Appearance * | pBoundingBox | ) |
| [in,out] | pBoundingBox | The bounding box of the signature field |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:NULL or not a valid bounding box | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_SetFieldNameA | ( | TPdfToolsSign_SignatureFieldOptions * | pSignatureFieldOptions, |
| const char * | szFieldName ) |
The name of the new signature field.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureFieldOptions | Acts as a handle to the native object of type TPdfToolsSign_SignatureFieldOptions. |
| [in] | szFieldName | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_SignatureFieldOptions_SetFieldNameW | ( | TPdfToolsSign_SignatureFieldOptions * | pSignatureFieldOptions, |
| const WCHAR * | szFieldName ) |
The name of the new signature field.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pSignatureFieldOptions | Acts as a handle to the native object of type TPdfToolsSign_SignatureFieldOptions. |
| [in] | szFieldName | Set value. |
| 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.
Adding a prepared signature is only required in very particular or specialized use cases. This method is the same as PdfToolsSign_Signer_Sign, but without actually creating the cryptographic signature. The cryptographic signature can be inserted later using PdfToolsSign_Signer_SignPreparedSignature.
While the pConfiguration can be created by any TPdfToolsCryptoProviders_Provider, it is typically created by PdfToolsCryptoProvidersBuiltIn_Provider_CreatePreparedSignature.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to add the prepared signature |
| [in,out] | pConfiguration | The signature configuration |
| [out] | pStreamDesc | The stream where the output document is written |
| [in,out] | pOutputOptions | Document-level output options not directly related to preparing the signature |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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.
Add an unsigned signature field that can later be signed (see TPdfToolsPdf_UnsignedSignatureField).
Non-critical processing errors raise a TPdfToolsSign_Signer_Warning. It is recommended to review the TPdfToolsSign_WarningCategory and handle them if necessary for the application.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to add the signature field to |
| [in,out] | pOptions | The options for the unsigned signature field |
| [out] | pStreamDesc | The stream where the output document is written |
| [in,out] | pOutputOptions | Document-level output options not directly related to the signature field |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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.
This type of signature provides evidence that the document existed at a specific time and protects the document’s integrity.
The features and format of the signature are defined by the TPdfToolsCryptoProviders_Provider and the pConfiguration.
Non-critical processing errors raise a TPdfToolsSign_Signer_Warning. It is recommended to review the TPdfToolsSign_WarningCategory and handle them if necessary for the application.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to add a time-stamp to |
| [in,out] | pConfiguration | The time-stamp configuration |
| [out] | pStreamDesc | The stream where the output document is written |
| [in,out] | pOutputOptions | Document-level output options not directly related to the document time-stamp |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_AddWarningHandlerA | ( | TPdfToolsSign_Signer * | pSigner, |
| void * | pContext, | ||
| TPdfToolsSign_Signer_WarningA | pFunction ) |
Adds event handler.
| [in,out] | pSigner | Pointer to the object to which the event handler is added. |
| [in,out] | pContext | The context of the event handler. |
| [in] | pFunction | The event callback that is added. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_AddWarningHandlerW | ( | TPdfToolsSign_Signer * | pSigner, |
| void * | pContext, | ||
| TPdfToolsSign_Signer_WarningW | pFunction ) |
Adds event handler.
| [in,out] | pSigner | Pointer to the object to which the event handler is added. |
| [in,out] | pContext | The context of the event handler. |
| [in] | pFunction | The event callback that is added. |
| 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.
This type of signature lets you detect rejected changes specified by the author. These signatures are also called Modification Detection and Prevention (MDP) signatures. The allowed permissions are defined by pPermissions.
The features and format of the signature are defined by the TPdfToolsCryptoProviders_Provider and the pConfiguration.
Non-critical processing errors raise a TPdfToolsSign_Signer_Warning. It is recommended to review the TPdfToolsSign_WarningCategory and handle them if necessary for the application.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to certify |
| [in,out] | pConfiguration | The signature configuration |
| [out] | pStreamDesc | The stream where the certified document is written |
| [in,out] | pPermissions | The permissions allowed. The default is ePdfToolsPdf_MdpPermissions_NoChanges. |
| [in,out] | pOutputOptions | Document-level output options not directly related to the document certification |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsSign_Signer *PDFTOOLS_CALL PdfToolsSign_Signer_New | ( | void | ) |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | 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.
Apply document-level processing options without any signature operation. For example:
Non-critical processing errors raise a TPdfToolsSign_Signer_Warning. It is recommended to review the TPdfToolsSign_WarningCategory and handle them if necessary for the application.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to process |
| [out] | pStreamDesc | The stream where the output document is written |
| [in,out] | pOutputOptions | The document-level processing options |
| [in,out] | pProvider | The cryptographic provider to use to add validation information to existing signatures of input document (see PdfToolsSign_OutputOptions_GetAddValidationInformation). Can be NULL if no validation information is added or to use the default provider. |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_RemoveWarningHandlerA | ( | TPdfToolsSign_Signer * | pSigner, |
| void * | pContext, | ||
| TPdfToolsSign_Signer_WarningA | pFunction ) |
Removes event handler.
| [in,out] | pSigner | Pointer to the object from which the event handler is removed. |
| [in,out] | pContext | The context of the event handler. |
| [in] | pFunction | The event callback that is removed. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_Signer_RemoveWarningHandlerW | ( | TPdfToolsSign_Signer * | pSigner, |
| void * | pContext, | ||
| TPdfToolsSign_Signer_WarningW | pFunction ) |
Removes event handler.
| [in,out] | pSigner | Pointer to the object from which the event handler is removed. |
| [in,out] | pContext | The context of the event handler. |
| [in] | pFunction | The event callback that is removed. |
| 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.
Document signatures are sometimes also called approval signatures. This type of signature lets you verify the integrity of the signed part of the document and authenticate the signer’s identity.
The features and format of the signature are defined by the TPdfToolsCryptoProviders_Provider and the pConfiguration.
Non-critical processing errors raise a TPdfToolsSign_Signer_Warning. It is recommended to review the TPdfToolsSign_WarningCategory and handle them if necessary for the application.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to sign |
| [in,out] | pConfiguration | The signature configuration |
| [out] | pStreamDesc | The stream where the signed document is written |
| [in,out] | pOutputOptions | Document-level output options not directly related to the signature |
NULL if there is an error.
NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| 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 PdfToolsSign_Signer_AddPreparedSignature. Note that the pConfiguration must be compatible to the configuration used when preparing the signature.
| [in,out] | pSigner | Acts as a handle to the native object of type TPdfToolsSign_Signer. |
| [in,out] | pDocument | The input document to sign |
| [in,out] | pConfiguration | The signature configuration |
| [out] | pStreamDesc | The stream where the signed document is written |
NULL if there is an error. NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsSign_Appearance *PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetAppearance | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration | ) |
The visual appearance of the time-stamp.
The visual appearance or NULL to create a time-stamp without a visual appearance.
For time-stamps, not all text variables are available, most notably the [signature:name].
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.
NULL is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetFieldNameA | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to time-stamp. Note that when an existing signature field is used, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_TimestampConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetFieldNameW | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to time-stamp. Note that when an existing signature field is used, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_TimestampConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
| [out] | pBuffer | Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size. |
| [in] | nBufferSize | The buffer size of the retrieved string pBuffer. |
pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below. 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsSign_TimestampConfigurationType PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_GetType | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration | ) |
Get actual derived type of base type TPdfToolsSign_TimestampConfiguration.
This function is invoked prior to downcasting to ascertain the derived object type.
| [in,out] | pTimestampConfiguration | Acts as a handle to a native object. |
0 in case of an error.0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetAppearance | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration, |
| TPdfToolsSign_Appearance * | pAppearance ) |
The visual appearance of the time-stamp.
The visual appearance or NULL to create a time-stamp without a visual appearance.
For time-stamps, not all text variables are available, most notably the [signature:name].
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
| [in,out] | pAppearance | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetFieldNameA | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration, |
| const char * | szFieldName ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to time-stamp. Note that when an existing signature field is used, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_TimestampConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
| [in] | szFieldName | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSign_TimestampConfiguration_SetFieldNameW | ( | TPdfToolsSign_TimestampConfiguration * | pTimestampConfiguration, |
| const WCHAR * | szFieldName ) |
The name of the existing signature field.
The PdfToolsPdf_SignatureField_GetFieldName of an existing, unsigned signature field to time-stamp. Note that when an existing signature field is used, the appearance's position is defined by the existing field. Therefore, make sure the PdfToolsSign_TimestampConfiguration_GetAppearance fits into the PdfToolsPdf_SignatureField_GetBoundingBox.
If NULL, a new signature field is created using a unique field name.
Default: NULL
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsSign_TimestampConfiguration. |
| [in] | szFieldName | Set value. |
1.10.0