PdfBaseDigSig class.
More...
|
virtual void | Destroy ()=0 |
| Destroys digital signature's resources. More...
|
|
virtual bool | SetReason (const wchar_t *reason)=0 |
| Sets the reason for the signing. More...
|
|
virtual bool | SetLocation (const wchar_t *location)=0 |
| Sets the location of signing. More...
|
|
virtual bool | SetContactInfo (const wchar_t *contact)=0 |
| Sets the contact information of the signer. More...
|
|
virtual bool | SetName (const wchar_t *name)=0 |
|
virtual bool | SetTimeStampServer (const wchar_t *url, const wchar_t *user_name, const wchar_t *password)=0 |
| Sets the timestamp server url and accesses credentials to apply the timestamp. More...
|
|
virtual bool | SignDoc (PdfDoc *doc, const wchar_t *path)=0 |
| Applies the digital signature and saves document to specified path. More...
|
|
PdfBaseDigSig class.
A digital signature can be used to authenticate the identity of a user and the document's contents. It stores information about the signer and the state of the document when it was signed.
◆ Destroy()
virtual void PdfBaseDigSig::Destroy |
( |
| ) |
|
|
pure virtual |
Destroys digital signature's resources.
- See also
- CreatePdfDigSig
◆ SetContactInfo()
virtual bool PdfBaseDigSig::SetContactInfo |
( |
const wchar_t * |
contact | ) |
|
|
pure virtual |
Sets the contact information of the signer.
- Parameters
-
contact | Information provided by the signer to enable a recipient to contact the signer to verify the signature, for example, a phone number, etc. |
- Returns
- true if was set successfully, false otherwise.
◆ SetLocation()
virtual bool PdfBaseDigSig::SetLocation |
( |
const wchar_t * |
location | ) |
|
|
pure virtual |
Sets the location of signing.
- Parameters
-
location | The CPU host name or physical location of the signing. |
- Returns
- true if was set successfully, false otherwise.
◆ SetName()
virtual bool PdfBaseDigSig::SetName |
( |
const wchar_t * |
name | ) |
|
|
pure virtual |
Sets the name of the person or authority signing the document. This value is be used when it is not possible to extract the name from the signature; for example, from the certificate of the signer or when PdfCustomDigSig is used.
- Parameters
-
- Returns
- true if was set successfully, false otherwise.
- See also
- PdfCustomDigSig
◆ SetReason()
virtual bool PdfBaseDigSig::SetReason |
( |
const wchar_t * |
reason | ) |
|
|
pure virtual |
Sets the reason for the signing.
- Parameters
-
reason | Reason for the signing. |
- Returns
- true if was set successfully, false otherwise.
◆ SetTimeStampServer()
virtual bool PdfBaseDigSig::SetTimeStampServer |
( |
const wchar_t * |
url, |
|
|
const wchar_t * |
user_name, |
|
|
const wchar_t * |
password |
|
) |
| |
|
pure virtual |
Sets the timestamp server url and accesses credentials to apply the timestamp.
- Parameters
-
url | The url of the timesramp server . |
user_name | The user name for accessing the timestamp server. |
password | The password for accessing the timestamp server. |
- Returns
- true if time stamp was set, false otherwise.
◆ SignDoc()
virtual bool PdfBaseDigSig::SignDoc |
( |
PdfDoc * |
doc, |
|
|
const wchar_t * |
path |
|
) |
| |
|
pure virtual |
Applies the digital signature and saves document to specified path.
- Parameters
-
doc | The document to be signed. |
path | The path where the signed document will be saved. |
- Returns
- true if document was signed, false otherwise.