Vanilla.PDF  1.5.2
Cross-platform toolkit for creating and modifying PDF documents
List of all members
DocumentSignatureSettingsHandle Class Reference

Group of settings controlling document's digital signature. More...

Inheritance diagram for DocumentSignatureSettingsHandle:
IUnknownHandle
error_type DocumentSignatureSettings_Create (DocumentSignatureSettingsHandle **result)
 Creates a new DocumentSignatureSettings instance.
 
error_type DocumentSignatureSettings_GetDigest (DocumentSignatureSettingsHandle *handle, MessageDigestAlgorithmType *result)
 Message digest algorithm for calculation hash of the data to be signed.
 
error_type DocumentSignatureSettings_SetDigest (DocumentSignatureSettingsHandle *handle, MessageDigestAlgorithmType value)
 Message digest algorithm for calculation hash of the data to be signed.
 
error_type DocumentSignatureSettings_GetSigningKey (DocumentSignatureSettingsHandle *handle, SigningKeyHandle **result)
 Get handle to key used for calculating document signature value.
 
error_type DocumentSignatureSettings_SetSigningKey (DocumentSignatureSettingsHandle *handle, SigningKeyHandle *value)
 Get handle to key used for calculating document signature value.
 
error_type DocumentSignatureSettings_GetName (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)
 Set the name of the person or authority signing the document.
 
error_type DocumentSignatureSettings_SetName (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)
 Set the name of the person or authority signing the document.
 
error_type DocumentSignatureSettings_GetLocation (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)
 Get the CPU host name or physical location of the signing.
 
error_type DocumentSignatureSettings_SetLocation (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)
 Get the CPU host name or physical location of the signing.
 
error_type DocumentSignatureSettings_GetReason (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle **result)
 Set the reason for the signing, such as (I agree...).
 
error_type DocumentSignatureSettings_SetReason (DocumentSignatureSettingsHandle *handle, LiteralStringObjectHandle *value)
 Set the reason for the signing, such as (I agree...).
 
error_type DocumentSignatureSettings_GetSigningTime (DocumentSignatureSettingsHandle *handle, DateHandle **result)
 The time of signing. More...
 
error_type DocumentSignatureSettings_SetSigningTime (DocumentSignatureSettingsHandle *handle, DateHandle *value)
 The time of signing.
 
error_type DocumentSignatureSettings_GetCertificate (DocumentSignatureSettingsHandle *handle, HexadecimalStringObjectHandle **result)
 An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.
 
error_type DocumentSignatureSettings_SetCertificate (DocumentSignatureSettingsHandle *handle, HexadecimalStringObjectHandle *value)
 An array of byte strings that shall represent the X.509 certificate chain used when signing and verifying signatures that use public-key cryptography, or a byte string if the chain has only one entry.
 
error_type DocumentSignatureSettings_ToUnknown (DocumentSignatureSettingsHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type DocumentSignatureSettings_FromUnknown (IUnknownHandle *handle, DocumentSignatureSettingsHandle **result)
 Convert IUnknownHandle to ObjectHandle.
 
error_type DocumentSignatureSettings_Release (DocumentSignatureSettingsHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Group of settings controlling document's digital signature.

See also
DigitalSignatureHandle
Examples:
sign.c, and sign_custom.c.

Friends And Related Function Documentation

◆ DocumentSignatureSettings_GetSigningTime()

error_type DocumentSignatureSettings_GetSigningTime ( DocumentSignatureSettingsHandle handle,
DateHandle **  result 
)
related

The time of signing.

Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server. This value should be used only when the time of signing is not available in the signature.

◆ DocumentSignatureSettings_Release()

error_type DocumentSignatureSettings_Release ( DocumentSignatureSettingsHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release
Examples:
sign.c, and sign_custom.c.

The documentation for this class was generated from the following file: