DL Logo

pdfprocessor Enumerations

PDFProcessorColorCompressionSet

Header: PDFProcessorExpT.h:97

Description

Enumeration for setting compression scheme for Color Images.

Enum Constants

kPDFProcessorColorJpegCompression
kPDFProcessorColorZipCompression
kPDFProcessorColorJpeg2000Compression

Used In

PDFProcessorGrayscaleCompressionSet

Header: PDFProcessorExpT.h:106

Description

Enumeration for setting compression scheme for Grayscale Images.

Enum Constants

kPDFProcessorGrayJpegCompression
kPDFProcessorGrayZipCompression
kPDFProcessorGrayJpeg2000Compression

Used In

PDFProcessorMonochromeCompressionSet

Header: PDFProcessorExpT.h:115

Description

Enumeration for setting compression scheme for Monochrome Images.

Enum Constants

kPDFProcessorMonoCCITTGroup3Compression
kPDFProcessorMonoCCITTGroup4Compression
kPDFProcessorMonoZipCompression
kPDFProcessorMonoRunLengthCompression

Used In

PDFProcessorPDFAConversionOption

Header: PDFProcessorExpT.h:27

Description

This is used to select which particular PDF/A standard we want to convert to.

Enum Constants

kPDFProcessorConvertToPDFA1aRGB
Convert to PDF/A-1a RGB
kPDFProcessorConvertToPDFA1aCMYK
Convert to PDF/A-1a CMYK
kPDFProcessorConvertToPDFA1bRGB
Convert to PDF/A-1b RGB
kPDFProcessorConvertToPDFA1bCMYK
Convert to PDF/A-1b CMYK
kPDFProcessorConvertToPDFA2aRGB
Convert to PDF/A-2a RGB
kPDFProcessorConvertToPDFA2aCMYK
Convert to PDF/A-2a CMYK
kPDFProcessorConvertToPDFA2bRGB
Convert to PDF/A-2b RGB
kPDFProcessorConvertToPDFA2bCMYK
Convert to PDF/A-2b CMYK
kPDFProcessorConvertToPDFA2uRGB
Convert to PDF/A-2u RGB
kPDFProcessorConvertToPDFA2uCMYK
Convert to PDF/A-2u CMYK
kPDFProcessorConvertToPDFA3aRGB
Convert to PDF/A-3a RGB
kPDFProcessorConvertToPDFA3aCMYK
Convert to PDF/A-3a CMYK
kPDFProcessorConvertToPDFA3bRGB
Convert to PDF/A-3b RGB
kPDFProcessorConvertToPDFA3bCMYK
Convert to PDF/A-3b CMYK
kPDFProcessorConvertToPDFA3uRGB
Convert to PDF/A-3u RGB
kPDFProcessorConvertToPDFA3uCMYK
Convert to PDF/A-3u CMYK
kPDFProcessorConvertToPDFA4RGB
Convert to PDF/A-4 RGB
kPDFProcessorConvertToPDFA4CMYK
Convert to PDF/A-4 CMYK
kPDFProcessorConvertToPDFA4eRGB
Convert to PDF/A-4e RGB
kPDFProcessorConvertToPDFA4eCMYK
Convert to PDF/A-4e CMYK
kPDFProcessorConvertToPDFA4fRGB
Convert to PDF/A-4f RGB
kPDFProcessorConvertToPDFA4fCMYK
Convert to PDF/A-4f CMYK

Used By

PDFProcessorPDFXConversionOption

Header: PDFProcessorExpT.h:78

Description

This is used to select which particular PDF/X standard we want to convert to.

Enum Constants

kPDFProcessorConvertToPDFX1a2001
Convert to PDF/X-1a 2001
kPDFProcessorConvertToPDFX32003
Convert to PDF/X-3 2003
kPDFProcessorConvertToPDFX42010
Convert to PDF/X-4 2010
kPDFProcessorConvertToPDFX62020
Convert to PDF/X-6 2020

Used By

pdfprocessor Callback Signatures

PDFProcessorProgressMon

Header: PDFProcessorExpT.h:129

Description

Prototype of the callback which is registered by the client with the plug-in

Syntax

ASBool PDFProcessorProgressMon(ASInt32 pageNum, ASInt32 totalPages, float current, void *clientData);

Parameters

pageNum
The current page which is processed by the plug-in. Indexed at 0.
totalPages
The total number of pages which are present in the input PDDoc.
current
The progress of the conversion process in percentage from 0-100.
clientData
The data which client registered to be called with the progress monitor.

Returns

If the client wants to abort the process then it should return value 1. Value 0 will allow process to continue normally.

Used In

pdfprocessor Structures

PDFProcessorPDFAConvertParams

Header: PDFProcessorExpT.h:134

Description

Structure to Control the PDF/A Processing.

Syntax

struct PDFProcessorPDFAConvertParams {
ASSize_t size;
The size of the structure. Set it to sizeof(PDFProcessorRec).
ASBool removeAllAnnotations;
Remove all annotations or actions regardless of what is allowed by a particular PDF/A version. The different PDF/A standards have different requirements as what types of annotations and actions are prohibited in order to comply with those standards. If false we will filter out all illegal annotations and actions (according to the standard being used) while retaining the legal ones. If true this will remove all annotations and actions from the output PDF/A file.
ASBool noRasterizationOnFontErrors;
If we encounter any errors like unembeddable fonts etc while conversion then we try to rasterize the current page on which the error occured. However the client can modify this behavior by setting the value of this parameter to true in which case we will throw an error if we encounter any problems while conversion. By default we will rasterize the page on error. If false we will try to rasterize the current page if any error occured. If true we will abort and throw an exception if any error occured.
ASBool abortIfXFAPresent;
The presence of XFA can result in some loss of data in output PDF/A-1 file as the PDFProcessor does not support XFA. However you can choose to abort the conversion if XFA is present by setting this parameter to true. By default we will not abort if XFA is present for PDF/A-1. If false we will convert even if XFA is found. If true we will abort the process if XFA is found.
Color Compression Setting for Color Images.
Compression Setting for Grayscale Images.
Compression Setting for Monochrome Images.
Client registered progress monitor callback which will be called to report the progress.
void *progMonData;
Client registered data sent back along with the progress monitor callback.
ASBool noValidationErrors;
When true, PDF implementation limits (as defined in the PDF Specification of the PDF/A target) of the page are ignored. When false, PDF implementation limits of the page are checked and if violated will cause the page to be rasterized as a fallback mechanism when noRasterizationOnFontErrors is false or simply raise an error if noRasterizationOnFontErrors is true.
ASUns16 rasterizationResolution;
When this value is zero, we will rasterize at 72 DPI (Legacy Behaviour). Otherwise, we will interpret the value as the desired resolution.
ASText OutputIntentName;
Add an ASText object, which, when present, will carry the name of a profile to use as output intent
ASBool validateImplementationLimitsOfDocument;
Validate PDF implementation limits (as defined in the PDF Specification of the PDF/A target) of the document. When true. PDF implementation limits are checked and if violated raise an error. When false, PDF implementation limits are not checked. Note this option applies to the whole document versus only pages in the noValidationErrors option.
} PDFProcessorPDFAConvertParamsRec, *PDFProcessorPDFAConvertParams;

Used By

PDFProcessorPDFXConvertParams

Header: PDFProcessorExpT.h:221

Description

Structure to Control the PDF/X Processing.

Syntax

struct PDFProcessorPDFXConvertParams {
ASSize_t size;
The size of the structure. Set it to sizeof(PDFProcessorRec).
ASBool removeAllAnnotations;
Some of the standards like PDF/X prohibit the presence of some types of annotations and actions in order to comply with those standards. If false we will filter out all illegal annotations and actions (according to the standard being used) while retaining the legal ones. If true this will remove all annotations and actions from the output PDF/X file.
ASBool abortIfXFAPresent;
Presence of XFA can result in some loss of data in output PDF/X file as PDFProcessor do not support XFA. However client can choose to abort the conversion in case XFA is present by setting this parameter to true. By default we will not abort if XFA is present. If false we will convert even if we detect the XFA form entry in PDDoc If true we will abort the process.
Color Compression Setting for Color Images.
Compression Setting for Grayscale Images.
Compression Setting for Monochrome Images.
Client registered progress monitor callback which will be called to report the progress.
void *progMonData;
Client registered data sent back along with the progress monitor callback.
ASText OutputIntentName;
Add an ASText object, which, when present, will carry the name of a profile to use as output intent
ASBool noValidationErrors;
When true, PDF implementation limits (as defined in the PDF Specification of the PDF/X target) of the page are ignored. When false, PDF implementation limits of the page are checked and if violated will raise an error.
ASBool ignoreColorConversion;
* Normally colors are changed to a CMYK-based space since this is the most desirable target output for print and is based on * the historical limitation of PDF/X-1A. * However the more recent PDF/X standards allow non-CMYK so if this option is set, colors aren't converted in the document. * This is for the case when you know you don't need to change any colors to achieve compliance.
} PDFProcessorPDFXConvertParamsRec, *PDFProcessorPDFXConvertParams;

Used By

pdfprocessor Functions

PDFProcessorConvertAndSaveToPDFA

Header: PDFProcessorProcs.h:36

Description

Processes a PDF file, converts it to a PDF/A standard, and saves the output document to disk.

Syntax

ASBool PDFProcessorConvertAndSaveToPDFA(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams);

Parameters

srcPDDoc
Input PDDoc to be converted.
outputFilePath
Output file path complete with the name of the PDF file we want to save the output to.
outputFileSys
Output File system.
option
Define the PDF/A conversion option.
userParams
Parameters to control the conversion.

Returns

True if conversion is successful. Will throw an exception in case of errors.

PDFProcessorConvertAndSaveToPDFX

Header: PDFProcessorProcs.h:68

Description

Processes a PDF file, converts it to a PDF/X standard and saves it to disk.

Syntax

ASBool PDFProcessorConvertAndSaveToPDFX(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams);

Parameters

srcPDDoc
Input PDDoc to be converted.
outputFilePath
Output file path complete with the name of the PDF file we want to save the output to.
outputFileSys
Output File system.
option
Define the PDF/X conversion option.
userParams
Parameters to control the conversion.

Returns

True if conversion is successful. Will throw an exception in case of errors.

PDFProcessorConvertToPDFA

Header: PDFProcessorProcs.h:49

Description

Processes a PDF file and provides a pointer to the converted PDDoc.

Syntax

ASBool PDFProcessorConvertToPDFA(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams, PDDocSaveParams outSaveParams);

Parameters

srcPDDoc
Input PDDoc to be converted.
outPDDocP
Pointer to the output PDDoc.
option
Define the PDF/A conversion option.
userParams
Parameters to control the conversion.
returnSaveParams
Return value containg the parameters value that should be used by the client to save the output PDDoc.

Returns

True if conversion is successful. Will throw an exception in case of errors.

PDFProcessorConvertToPDFX

Header: PDFProcessorProcs.h:81

Description

Processes a PDF file, and provides a pointer to the converted PDDoc.

Syntax

ASBool PDFProcessorConvertToPDFX(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams, PDDocSaveParams outSaveParams);

Parameters

srcPDDoc
Input PDDoc to be converted.
outPDDocP
Pointer to the output PDDoc.
option
Define the PDF/X conversion option.
userParams
Parameters to control the conversion.
returnSaveParams
Return value containg the parameters value that should be used by the client to save the output PDDoc.

Returns

True if conversion is successful. Will throw an exception in case of errors.

PDFProcessorInitialize

Header: PDFProcessorProcs.h:25

Description

Initialises the PDFProcessor Plug-in.

Syntax

ASBool PDFProcessorInitialize(void);

Returns

An ASBool value.

PDFProcessorTerminate

Header: PDFProcessorProcs.h:57

Description

Terminates the PDFProcessor Plug-in.

Syntax

void PDFProcessorTerminate(void);

Returns

void.