|
Pdftools SDK
|
Go to the source code of this file.
Typedefs | |
| typedef void(PDFTOOLS_CALL * | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredA) (void *pContext, const char *szUrl) |
| typedef void(PDFTOOLS_CALL * | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredW) (void *pContext, const WCHAR *szUrl) |
| #define PDFTOOLS_CALL |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForOnDemandIdentity PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForOnDemandIdentityA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForStaticIdentity PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForStaticIdentityA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateTimestamp PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateTimestampA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_Session_New PdfToolsCryptoProvidersSwisscomSigSrv_Session_NewA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_AddConsentRequiredHandler PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_AddConsentRequiredHandlerA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetLanguage PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetLanguageA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMessage PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMessageA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMSISDN PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMSISDNA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_New PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_NewA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_RemoveConsentRequiredHandler PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_RemoveConsentRequiredHandlerA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetLanguage PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetLanguageA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMessage PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMessageA |
| #define PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMSISDN PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMSISDNA |
| #define TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequired TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredA |
| typedef void(PDFTOOLS_CALL * TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredA) (void *pContext, const char *szUrl) |
Event containing the URL for step-up authentication using password and SMS challenge (OTP). Password and SMS challenge are used as a fallback mechanism for the Mobile ID authentication. For example, if the Mobile ID of the user is not activated. The user must be redirected to this URL for consent of will.
| [in,out] | pContext | Context of the event callback. |
| [in] | szUrl | The consent URL where the user must be redirected to acknowledge the declaration of will. |
| typedef void(PDFTOOLS_CALL * TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredW) (void *pContext, const WCHAR *szUrl) |
Event containing the URL for step-up authentication using password and SMS challenge (OTP). Password and SMS challenge are used as a fallback mechanism for the Mobile ID authentication. For example, if the Mobile ID of the user is not activated. The user must be redirected to this URL for consent of will.
| [in,out] | pContext | Context of the event callback. |
| [in] | szUrl | The consent URL where the user must be redirected to acknowledge the declaration of will. |
| PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForOnDemandIdentityA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const char * | szIdentity, | ||
| const char * | szDistinguishedName, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp ) |
Create a signature configuration for an on-demand certificate.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name›:‹key identity› Example: "ais-90days-trial:OnDemand-Advanced4" |
| [in] | szDistinguishedName | The requested distinguished name of the on-demand certificate. Example: "cn=Hans Muster,o=ACME,c=CH" |
| [in,out] | pStepUp | Options for step-up authorization using Mobile ID. |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForOnDemandIdentityW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const WCHAR * | szIdentity, | ||
| const WCHAR * | szDistinguishedName, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp ) |
Create a signature configuration for an on-demand certificate.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name›:‹key identity› Example: "ais-90days-trial:OnDemand-Advanced4" |
| [in] | szDistinguishedName | The requested distinguished name of the on-demand certificate. Example: "cn=Hans Muster,o=ACME,c=CH" |
| [in,out] | pStepUp | Options for step-up authorization using Mobile ID. |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForStaticIdentityA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const char * | szIdentity, | ||
| const char * | szName ) |
Create a signature configuration for a static certificate.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name›:‹key identity› Example: "ais-90days-trial:static-saphir4-ch" |
| [in] | szName | Name of the signer. This parameter is not used for certificate selection, but for the signature appearance and signature description in the PDF only. Example: "Signing Service TEST account" |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateSignatureForStaticIdentityW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const WCHAR * | szIdentity, | ||
| const WCHAR * | szName ) |
Create a signature configuration for a static certificate.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name›:‹key identity› Example: "ais-90days-trial:static-saphir4-ch" |
| [in] | szName | Name of the signer. This parameter is not used for certificate selection, but for the signature appearance and signature description in the PDF only. Example: "Signing Service TEST account" |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateTimestampA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const char * | szIdentity ) |
Create a time-stamp configuration.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name› Example: "ais-90days-trial" |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_CreateTimestampW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_Session * | pSession, |
| const WCHAR * | szIdentity ) |
Create a time-stamp configuration.
| [in,out] | pSession | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_Session. |
| [in] | szIdentity | The Claimed Identity string as provided by Swisscom: ‹customer name› Example: "ais-90days-trial" |
NULL if there is an error. NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_NewA | ( | const char * | szUrl, |
| TPdfTools_HttpClientHandler * | pHttpClientHandler ) |
| [in] | szUrl | The service endpoint base URL. Example: https://ais.swisscom.com |
| [in,out] | pHttpClientHandler | The SSL configuration with the client certificate and trust store. Use PdfTools_HttpClientHandler_SetClientCertificate to set your SSL client certificate "clientcert.p12" of your Swisscom Signing Service account. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_Session *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_Session_NewW | ( | const WCHAR * | szUrl, |
| TPdfTools_HttpClientHandler * | pHttpClientHandler ) |
| [in] | szUrl | The service endpoint base URL. Example: https://ais.swisscom.com |
| [in,out] | pHttpClientHandler | The SSL configuration with the client certificate and trust store. Use PdfTools_HttpClientHandler_SetClientCertificate to set your SSL client certificate "clientcert.p12" of your Swisscom Signing Service account. |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_GetAddTimestamp | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration | ) |
Whether to add a trusted time-stamp to the signature Default: FALSE.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_GetEmbedValidationInformation | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration | ) |
Whether to embed validation information into the signature (LTV)
Default: TRUE
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
May indicate an error in certain scenarios. For further information see the note section below.
| PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_GetHashAlgorithm | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration | ) |
The message digest algorithm.
The algorithm used to hash the document and from which the cryptographic signature is created.
Default: ePdfToolsCrypto_HashAlgorithm_Sha256
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT TPdfToolsCrypto_SignatureFormat PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_GetSignatureFormat | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration | ) |
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_AdbePkcs7Detached.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_SetAddTimestamp | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration, |
| BOOL | bAddTimestamp ) |
Whether to add a trusted time-stamp to the signature Default: FALSE.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
| [in] | bAddTimestamp | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_SetEmbedValidationInformation | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration, |
| BOOL | bEmbedValidationInformation ) |
Whether to embed validation information into the signature (LTV)
Default: TRUE
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
| [in] | bEmbedValidationInformation | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_SetHashAlgorithm | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration, |
| TPdfToolsCrypto_HashAlgorithm | iHashAlgorithm ) |
The message digest algorithm.
The algorithm used to hash the document and from which the cryptographic signature is created.
Default: ePdfToolsCrypto_HashAlgorithm_Sha256
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
| [in] | iHashAlgorithm | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration_SetSignatureFormat | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration * | pSignatureConfiguration, |
| TPdfToolsCrypto_SignatureFormat | iSignatureFormat ) |
The format (encoding) of the cryptographic signature Default: ePdfToolsCrypto_SignatureFormat_AdbePkcs7Detached.
| [in,out] | pSignatureConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_SignatureConfiguration. |
| [in] | iSignatureFormat | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_AddConsentRequiredHandlerA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| void * | pContext, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredA | pFunction ) |
Adds event handler.
| [in,out] | pStepUp | 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 PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_AddConsentRequiredHandlerW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| void * | pContext, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredW | pFunction ) |
Adds event handler.
| [in,out] | pStepUp | 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 size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetLanguageA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The language of the message Example: "DE"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetLanguageW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The language of the message Example: "DE"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMessageA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The message to be displayed on the mobile phone Example: "Do you authorize your signature on Contract.pdf?"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMessageW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The message to be displayed on the mobile phone Example: "Do you authorize your signature on Contract.pdf?"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMSISDNA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| char * | pBuffer, | ||
| size_t | nBufferSize ) |
The mobile phone number Example: "+41798765432"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_GetMSISDNW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| WCHAR * | pBuffer, | ||
| size_t | nBufferSize ) |
The mobile phone number Example: "+41798765432"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [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 there is an error. 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_NewA | ( | const char * | szMsisdn, |
| const char * | szMessage, | ||
| const char * | szLanguage ) |
| [in] | szMsisdn | The mobile phone number |
| [in] | szMessage | The message to be displayed on the mobile phone |
| [in] | szLanguage | The language of the message |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp *PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_NewW | ( | const WCHAR * | szMsisdn, |
| const WCHAR * | szMessage, | ||
| const WCHAR * | szLanguage ) |
| [in] | szMsisdn | The mobile phone number |
| [in] | szMessage | The message to be displayed on the mobile phone |
| [in] | szLanguage | The language of the message |
NULL if there is an error.
NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. | PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_RemoveConsentRequiredHandlerA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| void * | pContext, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredA | pFunction ) |
Removes event handler.
| [in,out] | pStepUp | 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 PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_RemoveConsentRequiredHandlerW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| void * | pContext, | ||
| TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp_ConsentRequiredW | pFunction ) |
Removes event handler.
| [in,out] | pStepUp | 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 PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetLanguageA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const char * | szLanguage ) |
The language of the message Example: "DE"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szLanguage | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetLanguageW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const WCHAR * | szLanguage ) |
The language of the message Example: "DE"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szLanguage | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMessageA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const char * | szMessage ) |
The message to be displayed on the mobile phone Example: "Do you authorize your signature on Contract.pdf?"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szMessage | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMessageW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const WCHAR * | szMessage ) |
The message to be displayed on the mobile phone Example: "Do you authorize your signature on Contract.pdf?"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szMessage | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMSISDNA | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const char * | szMSISDN ) |
The mobile phone number Example: "+41798765432"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szMSISDN | Set value. |
| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_StepUp_SetMSISDNW | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp * | pStepUp, |
| const WCHAR * | szMSISDN ) |
The mobile phone number Example: "+41798765432"
| [in,out] | pStepUp | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_StepUp. |
| [in] | szMSISDN | Set value. |
| PDFTOOLS_EXPORT TPdfToolsCrypto_HashAlgorithm PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration_GetHashAlgorithm | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration * | pTimestampConfiguration | ) |
The message digest algorithm.
The algorithm used to hash the document and from which the cryptographic signature is created.
Default: ePdfToolsCrypto_HashAlgorithm_Sha256
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration. |
May indicate an error in certain scenarios. For further information see the note section below.
0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:| PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration_SetHashAlgorithm | ( | TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration * | pTimestampConfiguration, |
| TPdfToolsCrypto_HashAlgorithm | iHashAlgorithm ) |
The message digest algorithm.
The algorithm used to hash the document and from which the cryptographic signature is created.
Default: ePdfToolsCrypto_HashAlgorithm_Sha256
| [in,out] | pTimestampConfiguration | Acts as a handle to the native object of type TPdfToolsCryptoProvidersSwisscomSigSrv_TimestampConfiguration. |
| [in] | iHashAlgorithm | Set value. |
1.10.0