#define FOUR_CHAR_CODE ( x )( x ) AC_Option_BlackPointCompensation=FOUR_CHAR_CODE('kptc') | Controls whether to adjust for differences in black points when converting colors between color spaces. If enabled the full dynamic range of the source space is mapped into the full dynamic range of the destination space. If disabled, the dynamic range of the source space is simulated in the destination space (which can result in blocked or gray shadows) This option is ignored if the rendering intent for the transformation is AC_AbsColorimetric. Default is 0 (zero).
|
AC_Option_Dither8=FOUR_CHAR_CODE('dth8') | Dither transformations to 8 bit color spaces. This may be ignored by optimized transforms. This option is used by AC_ApplyTransform. Default is 0 (zero).
|
AC_OptionCode_MaxEnum=0xFFFFFFFFL |
OnDisk=0 | Credential resides on-disk.
|
InMemory | Credential is cached in memory.
|
ExportType_Invalid | Used for error handeling
|
ExportType_TIF | Tagged Image File Format
|
ExportType_JPEG | Joint Photographic Experts Group
|
ExportType_BMP | Microsoft Windows Bitmap
|
ExportType_PNG | Portable Network Graphic
|
ExportType_GIF | Graphics Interchange Format
|
sha1=0 | SHA-1 message digest comprised of a 160-bit hash value.
|
sha224 | SHA-2 message digest comprised of a 224-bit hash value.
|
sha256 | SHA-2 message digest comprised of a 256-bit hash value.
|
sha384 | SHA-2 message digest comprised of a 384-bit hash value.
|
sha512 | SHA-2 message digest comprised of a 512-bit hash value.
|
sha3_224 | SHA-3 message digest comprised of a 224-bit hash value.
|
sha3_256 | SHA-3 message digest comprised of a 256-bit hash value.
|
sha3_384 | SHA-3 message digest comprised of a 384-bit hash value.
|
sha3_512 | SHA-3 message digest comprised of a 512-bit hash value.
|
shake128 | Extendable Output Function that generates a message digest comprised of a 128-bit hash value.
|
shake256 | Extendable Output Function that generates a message digest comprised of a 256-bit hash value.
|
kDisplayNone=0x0 | Do not display text labels or logo image. Note that specifying this option results in an empty signature appearance.
|
kDisplayAll=0x1 | Display all available text labels and logo image. Note that the application expects valid data to be supplied for each available label that will be displayed as a result of this option being selected.
|
kDisplayName=0x2 | Display the Name label.
|
kDisplayReason=0x4 | Display the Reason label.
|
kDisplayLocation=0x8 | Display the Location label.
|
kDisplayDate=0x10 | Display the Date label.
|
kDisplayContactInfo=0x20 | Display the ContactInfo label.
|
kDisplayDN=0x40 | Display the Signer Certificate's Distinguished Name label.
|
kDisplayLogo=0x80 | Display logo image.
|
FontRescan_Files=1 | This will rescan just the fields defined in dirList, plus those added with PDFLAddFontDirectories.
|
FontRescan_System=2 | This will rescan the system directories.
|
FontRescan_All=3 | This, or an "or" of the previous two, will rescan both.
|
SearchForFirstUnsignedField=0 | Search for the first available signature field, i.e., a field that does not contain a signature. No new signature field is created if none found. Exception raised if not found.
|
FieldCosObject | Cos object of an existing signature field that does not contain a signature. No new signature field is created if not found. Exception raised if not found.
|
FullyQualifiedFieldName | Fully qualified field name of a valid T entry in an existing field dictionary that is expected to contain the digital signature. Refer PDF specification ISO 32000-2:2020, Section 12.7.4.2 for additional information. No new signature field is created if not found. Exception raised if not found.
|
CreateFieldWithQualifiedName | Creates a new signature field to be signed using the T-entry fully qualified field name provided. The signature field created will contain neither parent nor child entries, i.e., the partial field name is the same as the fully qualified field name, per PDF specification ISO 32000-2:2020 Section 12.7.4.2. Field name provided shall not be separated by a period (.) character. Appearance of the generated signature field is determined by widget annotation attributes specified by signatureBoxInfo. If signatureBoxInfo is undefined, the annotation is not drawn, resulting in the creation of an invisible signature field on the first page.
|
NonPFX=0 | Base64-encoded or Binary DER (ASN.1 Distinguished Encoding Rules) format.
|
PFX | PKCS#12 format.
|
typedef struct _t_PDSignDocSaveParams *PDSignDocSaveParams; typedef struct _t_PDSignDocSignParams *PDSignDocSignParams; AC_Error ACGetOption(AC_OptionCode code, ASUns32 *value); code | AC_Option_BlackPointCompensation indicates whether the Acrobat Color Engine will carry out black point compensation when converting between colorspaces with different black points.
|
value | AC_Option_BlackPointCompensation flag value to be retrieved (Filled by the method)
|
AC_Error ACSetOption(AC_OptionCode code, ASUns32 value); The | option code.
|
value | The flag value to be set.
|
void ASSetDefaultFileSys(ASFileSys fileSys); fileSys | Alternate file system to be used
|
ASBool ConvertPDFToExcel(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); inputPath | The input path of the PDF document.
|
outputPath | The output path of the Office document.
|
fileSys | The File System in use.
|
ASBool ConvertPDFToPowerPoint(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); inputPath | The input path of the PDF document.
|
outputPath | The output path of the Office document.
|
fileSys | The File System in use.
|
ASBool ConvertPDFToWord(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); inputPath | The input path of the PDF document.
|
outputPath | The output path of the Office document.
|
fileSys | The File System in use.
|
PDEImage DLCreatePDEImageFromASFile(ASFile file); file | The ASFile representing the file.
|
PDEImage *DLCreatePDEImagesFromASFile(ASFile file); file | The ASFile representing the file.
|
PDEImage *DLCreatePDEImagesFromTIFF(ASPathName imageInputPath, ASFileSys fileSys); imageInputPath | The input path of the TIFF.
|
fileSys | The File System in use.
|
ASBool DLEnableLicensedBehavior(const char *keyVal, const char *additionalInfo); void DLExportImageToNChannelTIFF(char *buffer, size_t bufferSize, ASInt32 width, ASInt32 height, ASPathName outputPath, DLPDEImageExportParams exportParams, PDPageInk inks); void DLExportPDEImagesToTIFF(PDEImage *images, ASPathName outputPath, DLPDEImageExportParams exportParams); image | A null-terminated array of PDEImage's of interest.
|
outputPath | The output path of the TIFF file.
|
exportParams | The DLPDEImageExportParams structure.
|
DLImageExportType DLGetImageType(ASFile file); file | The ASFile representing the file.
|
This call allows Adobe PDF Library to rescan for fonts without re-initializing. This will allow an operating Library process to detect and update new font directories and resources after startup, without requiring a restart and re-initialization.
This will add one or more directories, and the fonts within them, to the set of all directories containing fonts (those specified in the DirList string arrays of resource locations).
This call should be followed by a call to PDFLRescanFontDirectories after all new font directories have been loaded.
ASBool PDFLAddFontDirectories(ASInt32 pathCount, ASPathName *paths); pathCount | Number of new paths to be added.
|
paths | Paths to new resource locations to be added.
|
ASInt32 PDFLReinit(void); This call allows Adobe PDF Library to rescan for fonts without re-initializing. This will allow an operating Library process to detect and update new font directories and resources after startup, without requiring a restart and re-initialization.
This call can, depending on flag settings, force a rescan of font resource areas defined in your dirList array, a rescan of those residing in the System folder, or both. To add new font resources to your dirList array, use the PDFLAddFontDirectories call.
ASBool PDFLRescanFontDirectories(FontRescanFlags flags); flags | Flags controlling rescan process.
|
CredentialDataFmt PDSignDocGetCredentialDataFormat(PDSignDocSignParams params); params | IN Object to be verified.
|
DigestCategory PDSignDocGetDigestCategory(PDSignDocSignParams params); IN | params PDSignDocSignParams object to be checked
|
PDDocVersion PDSignDocGetDocMajorVersionNumber(PDSignDocSaveParams params); params | IN Object to be checked.
|
PDDocVersion PDSignDocGetDocMinorVersionNumber(PDSignDocSaveParams params); params | IN Object to be checked.
|
SignatureFieldID PDSignDocGetFieldID(PDSignDocSignParams params); IN | params PDSignDocSignParams
|
ASConstText PDSignDocGetFieldName(PDSignDocSignParams params); params | IN PDSignDocSignParams object to be checked
|
CosObj PDSignDocGetFieldObject(PDSignDocSignParams params); params | IN PDSignDocSignParams object to be checked
|
ASPathName PDSignDocGetOutputPath(PDSignDocSaveParams params); params | IN Object to be verified.
|
ASUns32 PDSignDocGetSignatureBoxPageNumber(PDSignDocSignParams params); params | IN Object to be checked.
|
ASFixedRectP PDSignDocGetSignatureBoxRectangle(PDSignDocSignParams params); params | IN Object to be checked.
|
This will create a set of parameters used for saving the document to which a digital signature has been added. The parameters are set to default values and can be examined using "get" methods, and modified via "set" methods.
When these parameters are no longer needed (after the call to PDSignDocWithParams, although they can be re-used any number of times), they should be freed by the method PDSignDocSaveReleaseParams.
PDSignDocSaveParams PDSignDocSaveInitParams(void); void PDSignDocSaveReleaseParams(PDSignDocSaveParams params); params | IN Object to de-allocate.
|
void PDSignDocSetCancelProc(PDSignDocSaveParams params, ASCancelProc cancelProc, void *cancelProcClientData); params | IN Object to be modified.
|
cancelProc | A callback to test whether an operation should be cancelled. A CancelProc is typically passed to some method that takes a long time to complete. At frequent intervals, the method calls the CancelProc. If it returns true, then the method cancels its operation; if false, it continues. |
cancelProcClientData |
void PDSignDocSetCredentialDataFormat(PDSignDocSignParams params, CredentialDataFmt dataFmt); params | IN Object to be modified.
|
dataFmt | IN Encoding format of credentials used to sign a document.
|
void PDSignDocSetDigestCategory(PDSignDocSignParams params, DigestCategory digestCat); params | IN Object to be modified.
|
digestCat | IN Cryptographic hash function to use for generating message digests.
|
void PDSignDocSetDocMajorVersionNumber(PDSignDocSaveParams params, PDDocVersion major); params | IN Object to be modified.
|
major | IN The major PDF version number of the document. If major equals 0, both major and minor are ignored. Make sure that the document conforms to the version number that is specified.
|
void PDSignDocSetDocMinorVersionNumber(PDSignDocSaveParams params, PDDocVersion minor); params | IN Object to be modified.
|
minor | IN The minor PDF version number of the document.
|
void PDSignDocSetFieldID(PDSignDocSignParams params, SignatureFieldID id); params | IN Object to be modified.
|
id | IN Identifier to determine the form field that will contain the digital signature.
|
void PDSignDocSetFieldName(PDSignDocSignParams params, ASConstText fieldName); params | IN Object to be modified.
|
fieldName | IN Fully qualified name of the form field that will contain the digital signature.
|
void PDSignDocSetFieldObject(PDSignDocSignParams params, CosObj fieldObj); params | IN Object to be modified.
|
fieldObj | IN Cos object identifying the field dictionary that will contain the digital signature.
|
void PDSignDocSetFileSys(PDSignDocSaveParams params, ASFileSys outputFileSys); params | IN Object to be modified.
|
outputFileSys |
void PDSignDocSetNonPfxPassphrase(PDSignDocSignParams params, void *passphrase, ASSize_t passphraseSize, CredentialStorageFmt storageFmt); params | IN Object to be modified.
|
passphrase | |
passphraseSize | IN Passphrase size in bytes. Shall be set to 0 if private key is unencrypted or passphrase is stored on disk.
|
storageFmt | IN Storage format for passphrase.
|
void PDSignDocSetNonPfxPrivateKey(PDSignDocSignParams params, void *privateKey, ASSize_t keySize, CredentialStorageFmt storageFmt); params | IN Object to be modified.
|
privateKey | IN Private key.
|
keySize | IN Size of private key in bytes. Shall be set to 0 if key is stored on disk.
|
storageFmt | IN Storage format for private key.
|
void PDSignDocSetNonPfxSignerCert(PDSignDocSignParams params, void *signerCert, ASSize_t certSize, CredentialStorageFmt storageFmt); params | IN Object to be modified.
|
signerCert | IN Signer certificate.
|
certSize | IN Size of signer certificate in bytes. Shall be set to 0 if certificate is stored on disk.
|
storageFmt | IN Storage format for the signer certificate.
|
void PDSignDocSetOutputPath(PDSignDocSaveParams params, ASPathName outputPath); params | IN Object to be modified.
|
outputPath | IN The path to which the signed document is saved.
|
void PDSignDocSetPfxCredentials(PDSignDocSignParams params, void *credentials); params | IN Object to be modified.
|
credentials | IN Credentials in PFX/PKCS#12 file format.
|
void PDSignDocSetPfxPassphrase(PDSignDocSignParams params, void *passphrase, ASSize_t passphraseSize, CredentialStorageFmt storageFmt); params | IN Object to be modified.
|
passphrase | |
passphraseSize | |
storageFmt | IN Storage format for PFX/PKCS#12 credentials.
|
void PDSignDocSetProgressMon(PDSignDocSaveParams params, ASProgressMonitor progMon, void *progMonClientData); params | IN Object to be modified.
|
progMon | |
progMonClientData |
void PDSignDocSetSignatureBoxPageNumber(PDSignDocSignParams params, ASUns32 pageNumber); params | IN Object to be modified.
|
pageNumber | IN Page number on which to create the widget annotation.
|
void PDSignDocSetSignatureBoxRectangle(PDSignDocSignParams params, ASFixedRectP boxRect); params | IN Object to be modified.
|
boxRect | IN Dimension of the annotation rectangle of the signature field.
|
void PDSignDocSetSignerInfo(PDSignDocSignParams params, PDEImage logo, ASFixed opacity, ASConstText name, ASConstText location, ASConstText reason, ASConstText contactInfo, ASInt32 displayTraits); params | IN Object to be modified.
|
logo | IN Image to display as part of signature appearance.
|
opacity | IN Opacity of image to display as part of signature appearance.
|
name | IN Name of the person or authority signing the document.
|
location | IN CPU host name or physical location of the signing.
|
reason | IN Reason for signing the document.
|
contactInfo | IN Information provided by the signer to enable recipients to contact signer for signature verification.
|
displayTraits | IN DisplayTraits fields to display as part of signature appearance.
|
This will create a set of document signature parameters.
When these parameters are no longer needed (after the call to PDSignDocWithParams, although they can be re-used any number of times), they should be freed by the method PDSignDocSignReleaseParams.
PDSignDocSignParams PDSignDocSignInitParams(void); void PDSignDocSignReleaseParams(PDSignDocSignParams params); params | IN Object to deallocate.
|
Adds a digital signature using the specified credentials. If the document has not been previously signed, signs and saves the entire document. If the document has been previously signed, signs and saves only the portions of the document that have changed. If the document has been previously signed and the path to which the file is saved is NULL or the same as the path specified by the parameter, doc, signs and copies the document, saving only the portions of the document that have changed.
void PDSignDocWithParams(PDDoc doc, PDSignDocSaveParams saveParams, PDSignDocSignParams signParams); doc | IN/OUT The PDF document object.
|
saveParams | IN A PDSignDocSaveParams structure specifying how the document should be saved.
|
signParams | IN A PDSignDocSignParams structure specifying how the document should be signed.
|