Pdf Tcl Reference Documentation

Pdf

Current Version: 9.5.0.88

A PDF class for various tasks such as signature verification, signing, encrypt, decrypt, etc.

Object Creation

set myPdf [new CkPdf]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkPdf_get_DebugLogFilePath $myPdf $ckStr
set strVal [CkPdf_get_debugLogFilePath $myPdf]
CkPdf_put_DebugLogFilePath $myPdf $strVal

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
string
# ckStr is a CkString
CkPdf_get_LastErrorHtml $myPdf $ckStr
set strVal [CkPdf_get_lastErrorHtml $myPdf]

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
string
# ckStr is a CkString
CkPdf_get_LastErrorText $myPdf $ckStr
set strVal [CkPdf_get_lastErrorText $myPdf]

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
string
# ckStr is a CkString
CkPdf_get_LastErrorXml $myPdf $ckStr
set strVal [CkPdf_get_lastErrorXml $myPdf]

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkPdf_get_LastMethodSuccess $myPdf]
CkPdf_put_LastMethodSuccess $myPdf $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumPages
integer
set intVal [CkPdf_get_NumPages $myPdf]
Introduced in version 9.5.0.85

The number of pages in the currently open PDF.

top
NumSignatures
integer
set intVal [CkPdf_get_NumSignatures $myPdf]
Introduced in version 9.5.0.85

The number of digital signatures present in the currently open PDF.

top
UncommonOptions
string
# ckStr is a CkString
CkPdf_get_UncommonOptions $myPdf $ckStr
set strVal [CkPdf_get_uncommonOptions $myPdf]
CkPdf_put_UncommonOptions $myPdf $strVal
Introduced in version 9.5.0.85

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string. Can be set to a list of the following comma separated keywords:

  • "WriteStandardXref" - When writing the PDF, write the cross reference section in standard format if possible. (The "standard format" is the older non-compressed format.)

top
Utf8
boolean 1/0
set boolVal [CkPdf_get_Utf8 $myPdf]
CkPdf_put_Utf8 $myPdf $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkPdf_get_VerboseLogging $myPdf]
CkPdf_put_VerboseLogging $myPdf $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkPdf_get_Version $myPdf $ckStr
set strVal [CkPdf_get_version $myPdf]

Version of the component/library, such as "9.5.0.63"

top

Methods

AddSigningCert
# cert is a CkCert
set status [CkPdf_AddSigningCert $cert]
Introduced in version 9.5.0.85

Adds a certificate to be used for PDF signing. To sign with more than one certificate, call AddSigningCert once per certificate.

Note: This method is used to provide the ability to sign once with multiple certificates. This is different than signing with one certificate, and then signing again with a different certificate.

Returns 1 for success, 0 for failure.

top
GetDss
# json is a CkJsonObject
set status [CkPdf_GetDss $json]
Introduced in version 9.5.0.85

Gets the contents of the PDF's Document Security Store (/DSS) if it exists. Returns the information in JSON format (in json). If there is no /DSS then an empty JSON document "{}" is returned in json.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetSignerCert
# index is an integer
# cert is a CkCert
set status [CkPdf_GetSignerCert $index $cert]
Introduced in version 9.5.0.87

This method can be used to get the signer certificate after calling VerifySignature. The index should be the same value as the index passed to VerifySignature. If successful, and if the signer certificate is fully available within the signature, the cert is loaded with the signer certificate.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LastJsonData
# returns a CkJsonObject
set ret_jsonObject [CkPdf_LastJsonData]
Introduced in version 9.5.0.88

Provides information about what transpired in the last method called. For many methods, there is no information. For some methods, details about what transpired can be obtained via LastJsonData. For example, after calling a method to verify a signature, the LastJsonData will return JSON with details about the algorithms used for signature verification.

Returns NULL on failure

top
LoadBd
# pdfData is a CkBinData
set status [CkPdf_LoadBd $pdfData]
Introduced in version 9.5.0.85

Loads the PDF file contained in pdfData.

Returns 1 for success, 0 for failure.

top
LoadFile
# filePath is a string
set status [CkPdf_LoadFile $filePath]
Introduced in version 9.5.0.85

Load a PDF file into this object in memory.

Returns 1 for success, 0 for failure.

top
SetHttpObj
# http is a CkHttp
set status [CkPdf_SetHttpObj $http]
Introduced in version 9.5.0.85

Sets the HTTP object to be used to communicate with the timestamp authority (TSA) server for cases where long term validation (LTV) of signatures is desired. The http is used to send the requests, and it allows for connection related settings and timeouts to be set. For example, if HTTP or SOCKS proxies are required, these features can be specified on the http.

The http is also used to send OCSP requests to store OCSP responses in the PDF's document security store (DSS).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetSignatureJpeg
# jpgData is a CkBinData
set status [CkPdf_SetSignatureJpeg $jpgData]
Introduced in version 9.5.0.85

Provides an optional JPG image to be included in the signature appearance. The JPG data is passed in jpgData.

Returns 1 for success, 0 for failure.

top
SetSigningCert
# cert is a CkCert
set status [CkPdf_SetSigningCert $cert]
Introduced in version 9.5.0.85

Specifies a certificate to be used when signing the PDF. Signing requires both a certificate and private key. In this case, the private key is implicitly specified if the certificate originated from a PFX that contains the corresponding private key, or if on a Windows-based computer where the certificate and corresponding private key are pre-installed.

Returns 1 for success, 0 for failure.

top
SetSigningCert2
# cert is a CkCert
# privateKey is a CkPrivateKey
set status [CkPdf_SetSigningCert2 $cert $privateKey]
Introduced in version 9.5.0.85

Specifies a digital certificate and private key to be used for signing the PDF.

Returns 1 for success, 0 for failure.

top
SignPdf
# jsonOptions is a CkJsonObject
# outFilePath is a string
set status [CkPdf_SignPdf $jsonOptions $outFilePath]
Introduced in version 9.5.0.85

Signs the open PDF and if successful writes the signed PDF to the ARG3. The jsonOptions contains information and instructions about the signature.

Returns 1 for success, 0 for failure.

More Information and Examples
top
SignPdfAsync (1)
# returns a CkTask
# jsonOptions is a CkJsonObject
# outFilePath is a string
set ret_task [CkPdf_SignPdfAsync $jsonOptions $outFilePath]
Introduced in version 9.5.0.85

Creates an asynchronous task to call the SignPdf method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
VerifySignature
# index is an integer
# sigInfo is a CkJsonObject
set status [CkPdf_VerifySignature $index $sigInfo]
Introduced in version 9.5.0.85

Verifies the Nth signature contained in the PDF, where the 1st signature is indicated by an index of 0. Returns 1 if the signature valid, otherwise returns 0. The sigInfo is an output argument and is populated with information about the validated or unvalidated signature.

Returns 1 for success, 0 for failure.

More Information and Examples
top