Pdftools SDK
Loading...
Searching...
No Matches
Macros | Functions
PdfTools_PdfToolsSignatureValidationProfiles.h File Reference
#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

Go to the source code of this file.

Macros

#define PDFTOOLS_CALL
 

Functions

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_ValidationOptions *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetValidationOptions (TPdfToolsSignatureValidationProfiles_Profile *pProfile)
 Signature validation options.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_TrustConstraints *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetSigningCertTrustConstraints (TPdfToolsSignatureValidationProfiles_Profile *pProfile)
 Trust constraints for certificates of signatures.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_TrustConstraints *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetTimeStampTrustConstraints (TPdfToolsSignatureValidationProfiles_Profile *pProfile)
 Trust constraints for certificates of time-stamps.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CustomTrustList *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetCustomTrustList (TPdfToolsSignatureValidationProfiles_Profile *pProfile)
 The custom list of trusted certificates Default: NULL (no custom trust list)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_SetCustomTrustList (TPdfToolsSignatureValidationProfiles_Profile *pProfile, TPdfToolsSignatureValidation_CustomTrustList *pCustomTrustList)
 The custom list of trusted certificates Default: NULL (no custom trust list)
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_ProfileType PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetType (TPdfToolsSignatureValidationProfiles_Profile *pProfile)
 Get actual derived type of base type TPdfToolsSignatureValidationProfiles_Profile.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetTimeSource (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions)
 Allowed validation time sources.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetTimeSource (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions, TPdfToolsSignatureValidation_TimeSource iTimeSource)
 Allowed validation time sources.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions)
 Allowed sources to get certificates, e.g. intermediate issuer certificates.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetCertificateSources (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions, TPdfToolsSignatureValidation_DataSource iCertificateSources)
 Allowed sources to get certificates, e.g. intermediate issuer certificates.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetRevocationInformationSources (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions)
 Allowed sources to get revocation information (OCSP, CRL)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetRevocationInformationSources (TPdfToolsSignatureValidationProfiles_ValidationOptions *pValidationOptions, TPdfToolsSignatureValidation_DataSource iRevocationInformationSources)
 Allowed sources to get revocation information (OCSP, CRL)
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_GetTrustSources (TPdfToolsSignatureValidationProfiles_TrustConstraints *pTrustConstraints)
 Allowed sources for trusted certificates Note that the trust sources are implicitly added to the profile's PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_SetTrustSources (TPdfToolsSignatureValidationProfiles_TrustConstraints *pTrustConstraints, TPdfToolsSignatureValidation_DataSource iTrustSources)
 Allowed sources for trusted certificates Note that the trust sources are implicitly added to the profile's PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_RevocationCheckPolicy PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_GetRevocationCheckPolicy (TPdfToolsSignatureValidationProfiles_TrustConstraints *pTrustConstraints)
 Whether to check certificate revocation.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_SetRevocationCheckPolicy (TPdfToolsSignatureValidationProfiles_TrustConstraints *pTrustConstraints, TPdfToolsSignatureValidationProfiles_RevocationCheckPolicy iRevocationCheckPolicy)
 Whether to check certificate revocation.
 
PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_Default *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Default_New (void)
 

Macro Definition Documentation

◆ PDFTOOLS_CALL

#define PDFTOOLS_CALL

Function Documentation

◆ PdfToolsSignatureValidationProfiles_Default_New()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_Default *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Default_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_GetCustomTrustList()

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_CustomTrustList *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetCustomTrustList ( TPdfToolsSignatureValidationProfiles_Profile * pProfile)

The custom list of trusted certificates Default: NULL (no custom trust list)

Parameters
[in,out]pProfileActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_Profile.
Returns
Retrieved value.

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.

Note
An error occurred when NULL was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_GetSigningCertTrustConstraints()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_TrustConstraints *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetSigningCertTrustConstraints ( TPdfToolsSignatureValidationProfiles_Profile * pProfile)

Trust constraints for certificates of signatures.

Parameters
[in,out]pProfileActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_Profile.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_GetTimeStampTrustConstraints()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_TrustConstraints *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetTimeStampTrustConstraints ( TPdfToolsSignatureValidationProfiles_Profile * pProfile)

Trust constraints for certificates of time-stamps.

Parameters
[in,out]pProfileActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_Profile.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_GetType()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_ProfileType PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetType ( TPdfToolsSignatureValidationProfiles_Profile * pProfile)

Get actual derived type of base type TPdfToolsSignatureValidationProfiles_Profile.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters
[in,out]pProfileActs as a handle to a native object.
Returns
The item of the enumeration TPdfToolsSignatureValidationProfiles_ProfileType that refers to the actual derived type. 0 in case of an error.
Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_GetValidationOptions()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_ValidationOptions *PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_GetValidationOptions ( TPdfToolsSignatureValidationProfiles_Profile * pProfile)

Signature validation options.

Parameters
[in,out]pProfileActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_Profile.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_Profile_SetCustomTrustList()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_Profile_SetCustomTrustList ( TPdfToolsSignatureValidationProfiles_Profile * pProfile,
TPdfToolsSignatureValidation_CustomTrustList * pCustomTrustList )

The custom list of trusted certificates Default: NULL (no custom trust list)

Parameters
[in,out]pProfileActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_Profile.
[in,out]pCustomTrustListSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_TrustConstraints_GetRevocationCheckPolicy()

PDFTOOLS_EXPORT TPdfToolsSignatureValidationProfiles_RevocationCheckPolicy PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_GetRevocationCheckPolicy ( TPdfToolsSignatureValidationProfiles_TrustConstraints * pTrustConstraints)

Whether to check certificate revocation.

Parameters
[in,out]pTrustConstraintsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_TrustConstraints.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_TrustConstraints_GetTrustSources()

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_GetTrustSources ( TPdfToolsSignatureValidationProfiles_TrustConstraints * pTrustConstraints)

Allowed sources for trusted certificates Note that the trust sources are implicitly added to the profile's PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources.

Parameters
[in,out]pTrustConstraintsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_TrustConstraints.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_TrustConstraints_SetRevocationCheckPolicy()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_SetRevocationCheckPolicy ( TPdfToolsSignatureValidationProfiles_TrustConstraints * pTrustConstraints,
TPdfToolsSignatureValidationProfiles_RevocationCheckPolicy iRevocationCheckPolicy )

Whether to check certificate revocation.

Parameters
[in,out]pTrustConstraintsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_TrustConstraints.
[in]iRevocationCheckPolicySet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_TrustConstraints_SetTrustSources()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_TrustConstraints_SetTrustSources ( TPdfToolsSignatureValidationProfiles_TrustConstraints * pTrustConstraints,
TPdfToolsSignatureValidation_DataSource iTrustSources )

Allowed sources for trusted certificates Note that the trust sources are implicitly added to the profile's PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources.

Parameters
[in,out]pTrustConstraintsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_TrustConstraints.
[in]iTrustSourcesSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources()

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetCertificateSources ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions)

Allowed sources to get certificates, e.g. intermediate issuer certificates.

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_GetRevocationInformationSources()

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_DataSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetRevocationInformationSources ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions)

Allowed sources to get revocation information (OCSP, CRL)

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_GetTimeSource()

PDFTOOLS_EXPORT TPdfToolsSignatureValidation_TimeSource PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_GetTimeSource ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions)

Allowed validation time sources.

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
Returns
Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note
An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_SetCertificateSources()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetCertificateSources ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions,
TPdfToolsSignatureValidation_DataSource iCertificateSources )

Allowed sources to get certificates, e.g. intermediate issuer certificates.

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
[in]iCertificateSourcesSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_SetRevocationInformationSources()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetRevocationInformationSources ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions,
TPdfToolsSignatureValidation_DataSource iRevocationInformationSources )

Allowed sources to get revocation information (OCSP, CRL)

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
[in]iRevocationInformationSourcesSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

◆ PdfToolsSignatureValidationProfiles_ValidationOptions_SetTimeSource()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsSignatureValidationProfiles_ValidationOptions_SetTimeSource ( TPdfToolsSignatureValidationProfiles_ValidationOptions * pValidationOptions,
TPdfToolsSignatureValidation_TimeSource iTimeSource )

Allowed validation time sources.

Parameters
[in,out]pValidationOptionsActs as a handle to the native object of type TPdfToolsSignatureValidationProfiles_ValidationOptions.
[in]iTimeSourceSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.
Generated by doxygen 1.10.0