Layer

APDFL Plugins

6 components116 items
68 Functions 7 Typedefs 18 Structures 23 Enums

ocrengine

33 items

Functions(27)

PDOCRCreateForm

PDEForm PDOCRCreateForm(OCREngine engine, PDDoc doc, PDEImage image, ASInt32 resolution, OCRMissingFontStrategy strategy)
OCREngineProcs.h:59

Recognizes Text in a PDEImage, at a specified resolution, creating a PDEForm with the Image and Text underneath it. Knowing the image's resolution can enhance recognition. NOTE: Determining the resolution of the image is the caller's responsibility. Creates a PDEForm element containing the image, and additional text underneath. The PDEForm element has a transformation matrix which makes it directly substitutable for the image in a Content stream. The PDEForm will be created in the specified document, sharing fonts with the results of recognizing text in other images. If a font that will represent all the characters in a word can't be found, the missingFontStrategy will determine the behavior to employ.

Parameters
engine: OCREngine

IN OCREngine object

doc: PDDoc

IN PDDoc object

image: PDEImage
resolution: ASInt32

IN image resolution for PDEImage object, in DPI

strategy: OCRMissingFontStrategy

IN specifies the behavior to take if a Font isn't available to represent the Text

Returns
PDEForm

a PDEForm composing the supplied image with the recognized text underneath

PDOCRParamsGetCandidateFonts

ASAtom * PDOCRParamsGetCandidateFonts(OCRParams params)
OCREngineProcs.h:218

Get the Candidate Fonts used to try to match recognized text, as an array of ASAtoms. Each ASAtom represents a name for a font to try to use for text recognition. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter. A candidate font that is not installed is skipped. The default list names only fonts APDFL supplies. To recognize a script APDFL supplies no font for, use PDOCRParamsSetCandidateFonts() to add a font that covers it and that you have the right to embed. Each element is an ASAtom corresponding to a string representing a candidate font. This array can only be modified by calling PDOCRParamsSetCandidateFonts(). The length is given by PDOCRParamsGetNumCandidateFonts().

Parameters
params: OCRParams

IN OCRParams object

Returns
ASAtom *

an array of ASAtoms

PDOCRParamsGetNumCandidateFonts

ASInt32 PDOCRParamsGetNumCandidateFonts(OCRParams params)
OCREngineProcs.h:181

Get the Number of Candidate Fonts to try to match recognized text. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter. A candidate font that is not installed is skipped. The default list names only fonts APDFL supplies. To recognize a script APDFL supplies no font for, use PDOCRParamsSetCandidateFonts() to add a font that covers it and that you have the right to embed.

Parameters
params: OCRParams

IN OCRParams object

Returns
ASInt32

the number of candidate font members in the OCRParams

PDOCRParamsSetCandidateFonts

void PDOCRParamsSetCandidateFonts(OCRParams params, ASAtom *fonts, ASInt32 numFonts)
OCREngineProcs.h:252

Set the Candidate Fonts used to try to match recognized text. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter. A candidate font that is not installed is skipped. The default list names only fonts APDFL supplies. To recognize a script APDFL supplies no font for, use PDOCRParamsSetCandidateFonts() to add a font that covers it and that you have the right to embed. Each element is an ASAtom corresponding to a string representing a candidate font.

Parameters
params: OCRParams

IN OCRParams object

fonts: ASAtom *

IN an array of ASAtoms to set as candidate fonts

numFonts: ASInt32

the size of the fonts array

Returns
void

PDOCRParamsSetConfigParameter

ASBool PDOCRParamsSetConfigParameter(OCRParams params, const char *key, const char *value)
OCREngineProcs.h:275

Set an engine-specific configuration parameter. Multiple calls accumulate parameters. Calling with the same key replaces the previous value. These parameters are passed through to the underlying OCR engine (e.g., Tesseract) as engine-specific settings. See the OCR engine documentation for valid parameter names and values.

Parameters
params: OCRParams

IN OCRParams object to be modified.

key: const char *

IN Parameter name (will be copied). Must not be NULL.

value: const char *

IN Parameter value (will be copied). Must not be NULL.

Returns
ASBool

true on success, false on failure (e.g., NULL params/key/value or memory allocation failure).

Structures(2)

Enums(4)

OCRLanguage

OCREngineExpT.h:70

Enumeration to specify the language.

Values
OCRLanguage_English = 0
—
OCRLanguage_Dutch = 1
—
OCRLanguage_French = 2
—
OCRLanguage_German = 3
—
OCRLanguage_Italian = 4
—
OCRLanguage_Portuguese = 5
—
OCRLanguage_Spanish = 6
—
OCRLanguage_Arabic = 7
—
OCRLanguage_Armenian = 8
—
OCRLanguage_ChineseTraditional = 9
—
OCRLanguage_ChineseTraditionalVertical = 10
—
OCRLanguage_ChineseSimplified = 11
—
OCRLanguage_ChineseSimplifiedVertical = 12
—
OCRLanguage_Japanese = 13
—
OCRLanguage_JapaneseVertical = 14
—
OCRLanguage_Korean = 15
—
OCRLanguage_KoreanVertical = 16
—
OCRLanguage_Afrikaans = 17
—
OCRLanguage_Amharic = 18
—
OCRLanguage_Assamese = 19
—
OCRLanguage_Azerbaijani = 20
—
OCRLanguage_AzerbaijaniCyrillic = 21
—
OCRLanguage_Belarusian = 22
—
OCRLanguage_Bengali = 23
—
OCRLanguage_Tibetan = 24
—
OCRLanguage_Bosnian = 25
—
OCRLanguage_Breton = 26
—
OCRLanguage_Bulgarian = 27
—
OCRLanguage_Catalan = 28
—
OCRLanguage_Corsican = 29
—
OCRLanguage_Cebuano = 30
—
OCRLanguage_Czech = 31
—
OCRLanguage_Cherokee = 32
—
OCRLanguage_Welsh = 33
—
OCRLanguage_Danish = 34
—
OCRLanguage_DanishFraktur = 35
—
OCRLanguage_Dhivehi = 36
—
OCRLanguage_Dzongkha = 37
—
OCRLanguage_Greek = 38
—
OCRLanguage_EnglishMiddle = 39
—
OCRLanguage_Esperanto = 40
—
OCRLanguage_MathEquationDetection = 41
—
OCRLanguage_Estonian = 42
—
OCRLanguage_Faroese = 43
—
OCRLanguage_Basque = 44
—
OCRLanguage_Persian = 45
—
OCRLanguage_Finnish = 46
—
OCRLanguage_Filipino = 47
—
OCRLanguage_GermanFraktur = 48
—
OCRLanguage_FrenchMiddle = 49
—
OCRLanguage_Frisian = 50
—
OCRLanguage_Irish = 51
—
OCRLanguage_Galician = 52
—
OCRLanguage_ScotsGaelic = 53
—
OCRLanguage_GreekAncient = 54
—
OCRLanguage_Gujarati = 55
—
OCRLanguage_Haitian = 56
—
OCRLanguage_Hebrew = 57
—
OCRLanguage_Hindi = 58
—
OCRLanguage_Croatian = 59
—
OCRLanguage_Hungarian = 60
—
OCRLanguage_Inuktitut = 61
—
OCRLanguage_Indonesian = 62
—
OCRLanguage_Icelandic = 63
—
OCRLanguage_ItalianOld = 64
—
OCRLanguage_Javanese = 65
—
OCRLanguage_Kannada = 66
—
OCRLanguage_Georgian = 67
—
OCRLanguage_GeorgianOld = 68
—
OCRLanguage_Kazakh = 69
—
OCRLanguage_CentralKhmer = 70
—
OCRLanguage_Kyrgyz = 71
—
OCRLanguage_Kurmanji = 72
—
OCRLanguage_KurdishArabicScript = 73
—
OCRLanguage_Lao = 74
—
OCRLanguage_Latin = 75
—
OCRLanguage_Latvian = 76
—
OCRLanguage_Lithuanian = 77
—
OCRLanguage_Luxembourgish = 78
—
OCRLanguage_Malayalam = 79
—
OCRLanguage_Marathi = 80
—
OCRLanguage_Macedonian = 81
—
OCRLanguage_Maltese = 82
—
OCRLanguage_Mongolian = 83
—
OCRLanguage_Maori = 84
—
OCRLanguage_Malay = 85
—
OCRLanguage_Burmese = 86
—
OCRLanguage_Nepali = 87
—
OCRLanguage_Norwegian = 88
—
OCRLanguage_Occitan = 89
—
OCRLanguage_Oriya = 90
—
OCRLanguage_OrientationAndScriptDetection = 91
—
OCRLanguage_Panjabi = 92
—
OCRLanguage_Polish = 93
—
OCRLanguage_Pashto = 94
—
OCRLanguage_Quechua = 95
—
OCRLanguage_Romanian = 96
—
OCRLanguage_Russian = 97
—
OCRLanguage_Sanskrit = 98
—
OCRLanguage_Sinhala = 99
—
OCRLanguage_Slovak = 100
—
OCRLanguage_SlovakFraktur = 101
—
OCRLanguage_Slovenian = 102
—
OCRLanguage_Sindhi = 103
—
OCRLanguage_SpanishOld = 104
—
OCRLanguage_Albanian = 105
—
OCRLanguage_Serbian = 106
—
OCRLanguage_SerbianLatin = 107
—
OCRLanguage_Sundanese = 108
—
OCRLanguage_Swahili = 109
—
OCRLanguage_Swedish = 110
—
OCRLanguage_Syriac = 111
—
OCRLanguage_Tamil = 112
—
OCRLanguage_Tatar = 113
—
OCRLanguage_Telugu = 114
—
OCRLanguage_Tajik = 115
—
OCRLanguage_Tagalog = 116
—
OCRLanguage_Thai = 117
—
OCRLanguage_Tigrinya = 118
—
OCRLanguage_Tonga = 119
—
OCRLanguage_Turkish = 120
—
OCRLanguage_Uyghur = 121
—
OCRLanguage_Ukrainian = 122
—
OCRLanguage_Urdu = 123
—
OCRLanguage_Uzbek = 124
—
OCRLanguage_UzbekCyrillic = 125
—
OCRLanguage_Vietnamese = 126
—
OCRLanguage_Yiddish = 127
—
OCRLanguage_Yoruba = 128
—
OCRLanguage_None = 129
—

OCRMissingFontStrategy

OCREngineExpT.h:12

Enumeration to specify how to handle missing fonts during OCR.

Values
OCRMissingFontStrategy_Raise = 0
—

Raise an exception.

OCRMissingFontStrategy_Ignore = 1
—

Ignore the missing font and continue recognizing the next word of text.

OCRMissingFontStrategy_ReplacementText = 2
—

Replace the characters of text with the Unicode replacement Character. NOTE: the CandidateFontsNames member of the OCRParams instance must include a Font that can represent this character or an exception will be raised.

OCRPageSegmentationMode

OCREngineExpT.h:40

Enumeration to specify how the OCR engine will view the page, and how it detects text segments.

Values
OCRPageSegmentationMode_OSDOnly = 0
—

Orientation and script detection (OSD).

OCRPageSegmentationMode_AutomaticOSD = 1
—

Automatic page segmentation with OSD.

OCRPageSegmentationMode_Automatic = 2
—

Automatic without OSD.

OCRPageSegmentationMode_SingleColumn = 3
—

Assume a single column of text.

OCRPageSegmentationMode_SingleBlockVertical = 4
—

Assume a single block of vertically aligned text.

OCRPageSegmentationMode_SingleBlock = 5
—

Assume a single block of text.

OCRPageSegmentationMode_SingleLine = 6
—

Assume a single line of text.

OCRPageSegmentationMode_SingleWord = 7
—

Assume a single word.

OCRPageSegmentationMode_CircleWord = 8
—

Assume a single word in a circle.

OCRPageSegmentationMode_SingleChar = 9
—

Assume a single char.

OCRPageSegmentationMode_SparseText = 10
—

Find all text in no particular order.

OCRPageSegmentationMode_SparseTextOSD = 11
—

Sparse text with OSD.

OCRPageSegmentationMode_RawLine = 12
—

Treat as a raw line with no input processing.

OCRPerformance

OCREngineExpT.h:24

Enumeration to specify OCR performance.

Values
OCRPerformance_Default = 0
—

Default performance.

The default performance is useful for most scenarios and is a reasonable tradeoff of speed vs. accuracy, thus suitable for most languages.

OCRPerformance_Accuracy = 1
—

Blend accuracy with speed.

OCRPerformance_MoreAccuracy = 2
—

Favor accuracy over speed.

OCRPerformance_BestAccuracy = 3
—

Best possible accuracy.

officetopdf

22 items

Functions(15)

OfficeToPDFConvertFromMemory

OfficeToPDFResult OfficeToPDFConvertFromMemory(const unsigned char *inputBytes, ASSize_t inputLength, const OfficeToPDFParamsRec *params)
OfficeToPDFProcs.h:92

Converts a Word document held in memory, and returns the PDF as bytes on the result, read with OfficeToPDFResultGetOutput(). The plug-in spools the document through a directory of its own in the system's temporary directory, which on Linux and macOS only the converting user can enter, and removes it before it returns.

Parameters
inputBytes: const unsigned char *

The .docx's bytes.

inputLength: ASSize_t

How many bytes there are.

params: const OfficeToPDFParamsRec *

The parameters, or NULL for the defaults.

Returns
OfficeToPDFResult

The conversion's result, which the host releases.

OfficeToPDFConvertToDocument

OfficeToPDFResult OfficeToPDFConvertToDocument(const char *inputPath, PDDoc *outDocument, const OfficeToPDFParamsRec *params)
OfficeToPDFProcs.h:65

Converts a Word document, and returns the PDF as an open document the host owns. The host can merge, stamp, sign or save the document through the library, and closes it when it is done. The plug-in keeps no reference to it. The document is ready to save as it is: every font carries its ToUnicode map and widths, and the document is marked PDF 1.7. A save without PDSaveKeepModDate stamps the system clock as the /ModDate, in place of the conversion's.

Parameters
inputPath: const char *

The .docx to convert, as a UTF-8 path.

outDocument: PDDoc *

Receives the document, or NULL when the conversion fails. When it is NULL itself, nothing is converted, and the status is kOfficeToPDFErrorDestinationNotWritable, whatever the input; only the checks every conversion makes first, that the plug-in is initialized and the library is started on the thread, come before it.

params: const OfficeToPDFParamsRec *

The parameters, or NULL for the defaults.

Returns
OfficeToPDFResult

The conversion's result, which the host releases.

OfficeToPDFConvertToFile

OfficeToPDFResult OfficeToPDFConvertToFile(const char *inputPath, const char *outputPath, const OfficeToPDFParamsRec *params)
OfficeToPDFProcs.h:78

Converts a Word document, and writes the PDF to a file. On success the file holds the complete PDF, replacing any file that was there. On failure nothing is written, and a file that was there is left as it was.

Parameters
inputPath: const char *

The .docx to convert, as a UTF-8 path.

outputPath: const char *

Where to write the PDF, as a UTF-8 path.

params: const OfficeToPDFParamsRec *

The parameters, or NULL for the defaults.

Returns
OfficeToPDFResult

The conversion's result, which the host releases.

OfficeToPDFGetVersionString

const char * OfficeToPDFGetVersionString(void)
OfficeToPDFProcs.h:154

The plug-in's version, "MAJOR.MINOR.PATCH": never NULL, and the same version the plug-in's file carries. A host can check it before it relies on a diagnostic kind or a behaviour its header predates. It is not the table's version, OfficeToPDFHFTVersion.

Parameters
: void
Returns
const char *

OfficeToPDFInitParams

void OfficeToPDFInitParams(OfficeToPDFParams params)
OfficeToPDFProcs.h:43

Fills a parameters record with the defaults: the system clock, and comments omitted. Set params->size to sizeof(OfficeToPDFParamsRec) first. The plug-in writes only the first size bytes, so a plug-in newer than the host's header never writes past the record, and it leaves size as the host set it.

Parameters
params: OfficeToPDFParams

The record to fill. NULL is ignored.

Returns
void

OfficeToPDFInitialize

ASBool OfficeToPDFInitialize(void)
OfficeToPDFProcs.h:26

Initializes the plug-in, and returns true when it is ready. The library initializes the plug-in when it loads it, so a host that has the table finds the plug-in ready, and again on each thread that starts the library afterwards; neither lifts an OfficeToPDFTerminate() the host called, which only this selector does. It may run any number of times, including after OfficeToPDFTerminate(). A host that links the plug-in directly (OfficeToPDFCalls.h) calls it before converting. It never initializes Adobe PDF Library: the host starts the library on each thread it converts on.

Parameters
: void
Returns
ASBool

OfficeToPDFResultGetOutput

ASBool OfficeToPDFResultGetOutput(OfficeToPDFResult result, const unsigned char **outBytes, ASSize_t *outLength)
OfficeToPDFProcs.h:142

The PDF's bytes, from a memory conversion that succeeded. The bytes belong to the result.

Parameters
result: OfficeToPDFResult

The result to read.

outBytes: const unsigned char **

Receives the bytes.

outLength: ASSize_t *

Receives how many there are.

Returns
ASBool

True when the result holds bytes. False, with both outputs left as they were, for a file or document conversion, a failed one, a NULL result or a NULL output.

OfficeToPDFTerminate

void OfficeToPDFTerminate(void)
OfficeToPDFProcs.h:33

Terminates the plug-in. Until OfficeToPDFInitialize() runs again, a conversion does nothing and returns kOfficeToPDFErrorNotInitialized, on every thread, including one that starts the library afterwards. Results the host holds stay valid. It may run any number of times, and before any OfficeToPDFInitialize(). It never terminates Adobe PDF Library.

Parameters
: void
Returns
void

Typedefs(1)

Structures(3)

OfficeToPDFParamsRec

struct OfficeToPDFParamsRec
OfficeToPDFExpT.h:261

A conversion's parameters. Set size to sizeof(OfficeToPDFParamsRec), then call OfficeToPDFInitParams() for the defaults: the system clock, and comments omitted. The record only grows at its end, and the plug-in writes and reads only the first size bytes, taking the default for any member past them, so a host built against an older header keeps working with a newer plug-in. A conversion given a NULL record takes every default. One record serves any number of conversions.

Fields
size: ASSize_t

The record's size in bytes. The host sets it; the plug-in never changes it.

useConversionTime: ASBool

When true, conversionTime is stamped as the PDF's /CreationDate and /ModDate and used for the document's DATE and TIME fields, so every conversion of a document carries the same dates and field text. When false, the default, the system clock is used.

conversionTime: OfficeToPDFTimestamp

The instant used when useConversionTime is true.

comments: OfficeToPDFCommentRendering

How the document's comments appear. The default is kOfficeToPDFCommentsOmit.

OfficeToPDFResult

typedef struct _t_OfficeToPDFResult* OfficeToPDFResult
OfficeToPDFExpT.h:292

One conversion's result: its status, its message, its per-asset diagnostics and, for a memory conversion, the PDF's bytes. The plug-in allocates a result and the host releases it, once, with OfficeToPDFResultRelease(). Everything an accessor returns belongs to the result and stays valid until the release, so copy what you keep. A result stays valid after OfficeToPDFTerminate(). Release every result before the library unloads the plug-in, because the code that releases a result is unloaded with it. A conversion returns NULL only when it cannot allocate its result. Every accessor, and the release, accept NULL.

Enums(3)

OfficeToPDFCommentRendering

OfficeToPDFExpT.h:214

How the document's Word comments appear in the PDF.

Values
kOfficeToPDFCommentsOmit = 0
—

The default: the PDF carries no trace of the comments.

kOfficeToPDFCommentsMargin = 1
—

Word's printed markup: a markup area beside each page, with each comment in a box joined to its anchor.

kOfficeToPDFCommentsAnnotations = 2
—

PDF annotations: a note at each comment's anchor, carrying its author, its time and its text. The pages draw as with kOfficeToPDFCommentsOmit.

Used In
OfficeToPDFParamsRec

OfficeToPDFDiagnosticKind

OfficeToPDFExpT.h:146

What a per-asset diagnostic reports, read with OfficeToPDFResultGetDiagnosticKind(). A diagnostic describes something the conversion approximated or replaced; it does not change the status, and a successful conversion can report several. A kind above the highest this header names comes from a newer plug-in: treat it as other, and read the diagnostic's asset and message.

Values
kOfficeToPDFDiagPlaceholderImage = 0
—

A placeholder was drawn for content that could not be rendered: an image that would not decode, a SmartArt diagram with nothing to draw, or a graphic of no known kind.

kOfficeToPDFDiagSubstitutedFont = 1
—

A font was not available, and another was used.

kOfficeToPDFDiagEmbeddedFont = 2
—

A font embedded in the document was used.

kOfficeToPDFDiagSynthesizedFont = 3
—

A font lacked the bold or italic face asked for, and one was synthesized.

kOfficeToPDFDiagPlaceholderEquation = 4
—

An equation could not be drawn as math, and a placeholder was drawn.

kOfficeToPDFDiagMathFontFallback = 5
—

No usable OpenType MATH font was available, so default math metrics were used.

kOfficeToPDFDiagChart = 6
—

A chart was drawn; the message names how.

kOfficeToPDFDiagPlaceholderChart = 7
—

A chart could not be drawn, and a placeholder was drawn.

kOfficeToPDFDiagDroppedLink = 8
—

A hyperlink's text was drawn, but the link was not made clickable.

kOfficeToPDFDiagUnsupportedGraphic = 9
—

A graphic was left out, and nothing was drawn in its place.

kOfficeToPDFDiagSeparatorFallback = 10
—

A custom note separator could not be used, and the default rule was drawn.

kOfficeToPDFDiagHeaderFooterNoteClipped = 11
—

A note referenced from a header or footer was clipped.

kOfficeToPDFDiagInertNestedReference = 12
—

A note reference inside another note was drawn as plain content.

kOfficeToPDFDiagNoteContinuationExhausted = 13
—

A note ran past the pages it may continue on, and the rest was clipped.

kOfficeToPDFDiagApproximatedShape = 14
—

A shape was drawn as an approximation of its geometry, fill or 3-D scene.

kOfficeToPDFDiagUnshapedText = 15
—

Arabic-script text or a ligature could not take its shaped form, and was drawn one code point at a time.

kOfficeToPDFDiagWatermark = 16
—

A watermark was drawn degraded, or not drawn.

kOfficeToPDFDiagApproximatedPicture = 17
—

A picture's styling was drawn as an approximation.

kOfficeToPDFDiagUnresolvedPictureStyle = 18
—

A picture's theme reference could not be resolved.

kOfficeToPDFDiagFloatPlacementUnresolved = 19
—

The placement of floating objects and notes did not settle, so a floating object may sit on a page next to its anchor's, or a note area may overlap body text.

kOfficeToPDFDiagDegenerateGeometry = 20
—

A section's page geometry left no body area, and a minimum was used.

kOfficeToPDFDiagComment = 21
—

A Word comment was left out or degraded.

kOfficeToPDFDiagFloatNotPlaced = 22
—

A floating object could not be placed where the layout planned it, or has no visible area on its page. It is still drawn.

kOfficeToPDFDiagVariantUnavailable = 23
—

A run asked for a variant of a character, through a variation selector, that its font does not define, or the font's variation table could not be read. The character was drawn in its default form. The asset is the PostScript name of the font that drew it, e.g. KozMinPr6N-Regular, which may be a font substituted for the document's; the message names the sequence's code points. Reported once per font and sequence.

OfficeToPDFStatus

OfficeToPDFExpT.h:120

A conversion's outcome, read with OfficeToPDFResultGetStatus(). Each failure has its own code, so a host can handle each cause its own way.

Values
kOfficeToPDFSuccess = 0
—

A valid PDF was produced.

kOfficeToPDFErrorInputNotFound = 1
—

The source does not exist or cannot be read.

kOfficeToPDFErrorInvalidInput = 2
—

The source is not a valid .docx document.

kOfficeToPDFErrorInputProtected = 3
—

The source is password-protected.

kOfficeToPDFErrorDestinationNotWritable = 4
—

The destination cannot be written. Nothing was written to it.

kOfficeToPDFErrorConversionFailed = 5
—

The conversion failed on a valid source, or the calling thread has not started Adobe PDF Library.

kOfficeToPDFErrorNotInitialized = 6
—

The plug-in is not initialized, and nothing was done. Either OfficeToPDFTerminate() ran, or a host that links the plug-in directly has not called OfficeToPDFInitialize().

pdflattener

14 items

Functions(6)

PDFlattenerConvert

ASBool PDFlattenerConvert(PDDoc aPDDoc, PDFlatten flattenParams, float transQuality, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, ASUns32 flags)
PDFlattenerProcs.h:37

Flatten a PDF file.

Parameters
aPDDoc: PDDoc

The input PDDoc which we want to Flatten. The output will be in the same PDDoc.

flattenParams: PDFlatten

Input parameters for flattening.

transQuality: float
firstPage: ASUns32

The first page of aPDDoc which we want to Flatten.

lastPage: ASUns32

The last page of aPDDoc which we want to Flatten.

numFlattenedPages: ASUns32 *

set to the number of pages that are flattened.

flags: ASUns32

Kept for future use. Default to 0.

Returns
ASBool

1 on success.

PDFlattenerConvertEx

ASBool PDFlattenerConvertEx(PDDoc aPDDoc, PDFlatten flattenParams, float transQuality, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, ASUns32 flags, FlattenProgressMonitor FlattenProgress, void *progressClientData)
PDFlattenerProcs.h:58

Flatten a PDF file.

Parameters
aPDDoc: PDDoc

The input PDDoc which we want to Flatten. The output will be in the same PDDoc.

flattenParams: PDFlatten

Input parameters for flattening.

transQuality: float
firstPage: ASUns32

The first page of aPDDoc which we want to Flatten.

lastPage: ASUns32

The last page of aPDDoc which we want to Flatten.

numFlattenedPages: ASUns32 *

set to the number of pages that are flattened.

flags: ASUns32

Kept for future use. Default to 0.

FlattenProgress: FlattenProgressMonitor

the callback which we want to register with the plug-in.

progressClientData: void *

any client data which client wants to get back with the callback for its own reference.

Returns
ASBool

1 on success.

PDFlattenerConvertEx2

ASBool PDFlattenerConvertEx2(PDDoc aPDDoc, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, PDFlattenerUserParams userParams)
PDFlattenerProcs.h:69

Flatten a PDF file.

Parameters
aPDDoc: PDDoc

The input PDDoc which we want to Flatten. The output will be in the same PDDoc.

firstPage: ASUns32

The first page of aPDDoc which we want to Flatten.

lastPage: ASUns32

The last page of aPDDoc which we want to Flatten.

numFlattenedPages: ASUns32 *

set to the number of pages that are flattened.

userParams: PDFlattenerUserParams

A structure object defined for user set parameters e.g flattenParams, transquality, Blending Colorspace profile, progress monitor and Compression Settings.

Returns
ASBool

1 on success.

PDFlattenerConvertEx3

ASBool PDFlattenerConvertEx3(PDDoc aPDDoc, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, PDFlattenerUserParams userParams, ASBool embedFlattenerProfiles)
PDFlattenerProcs.h:81

Flatten a PDF file.

Parameters
aPDDoc: PDDoc

The input PDDoc which we want to Flatten. The output will be in the same PDDoc.

firstPage: ASUns32

The first page of aPDDoc which we want to Flatten.

lastPage: ASUns32

The last page of aPDDoc which we want to Flatten.

numFlattenedPages: ASUns32 *

set to the number of pages that are flattened.

userParams: PDFlattenerUserParams

A structure object defined for user set parameters e.g flattenParams, transquality, Blending Colorspace profile, progress monitor and Compression Settings.

embedFlattenerProfiles: ASBool

embed Flattener color profiles.

Returns
ASBool

1 on success.

Typedefs(1)

Structures(2)

PDFlattenerUserParamsRec

struct PDFlattenerUserParamsRec
PDFlattenerExpT.h:94
Fields
size: size_t

Set this to be the size of this struct.

flattenParams: PDFlatten

Flatten Params Input parameters for flattening.

transQuality: float

Raster/Vector Balance.

flattenProgress: FlattenProgressMonitor

Client registered progress monitor callback which will be called to report the progress.

progressClientData: void *

Client registered data send back along with the progress monitor callback.

profileDesc: ASText

Profile Descriptions for use with this parameter can be found with ACMakeProfileList and ACProfileListItemDescription.

The best practice, however, is generally to leave this parameter as null so that defaults can be used.

If this parameter is set, it overrides the values set by PDPageSetBlendingProfile and PDPresetDefaultBlendingProfile, and will be used as the blending space for each page prior to flattening. It will override any existing page blending spaces.

This will be true regardless of how the existing page blending space was defined.

If the parameter is null, the blending space for each page will be either the value previously set by PDPageSetBlendingSpace, or the value contained in the Group entry of the page, which defines it's Blending space.

If neither of these has been used, it will be the value in PDPresefSetDefaultBlendingColorSpace if this is set.

If none of the above are true, it will be the Working Space for CMYK.

If that working space is not used, the profile for U.S. Web Coated SWOP (v2) will be used.

Note that within a page, there may be transparency groups. These groups will contain their own blending profile, and their contents will blend via that profile. The group as a whole will then blend into the page using the page's blending profile.

colorCompression: PDFlattenerColorCompSet

Color Compression Setting for Flattened color Images.

grayCompression: PDFlattenerGrayscaleCompSet

Compression Setting for Flattened Grayscale Images.

monoCompression: PDFlattenerMonochromeCompSet

Compression Setting for Flattened Monochrome Images.

colorImageQuality: PDFlattenerQualitySetting

Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of colorCompression is equal to kPDFlattenerJpegCompression or kPDFlattenerJpeg2000Compression

grayImageQuality: PDFlattenerQualitySetting

Quality Setting for Flattened JPEG and JPEG2000 gray scale Images. This is valid only if the value of grayCompression is equal to kPDFlattenerGrayJpegCompression or kPDFlattenerGrayJpeg2000Compression

Enums(5)

PDFlattenerColorCompSet

PDFlattenerExpT.h:27

Enumeration for setting compression scheme for flattened color images.

Values
kPDFlattenerJpegCompression = 0
—
kPDFlattenerZipCompression = 1
—
kPDFlattenerJpeg2000Compression = 2
—
Used In
PDFlattenerUserParamsRec

PDFlattenerGrayscaleCompSet

PDFlattenerExpT.h:36

Enumeration for setting the compression scheme for the Flattened Grayscale images.

Values
kPDFlattenerGrayJpegCompression = 0
—
kPDFlattenerGrayZipCompression = 1
—
kPDFlattenerGrayJpeg2000Compression = 2
—
Used In
PDFlattenerUserParamsRec

PDFlattenerMonochromeCompSet

PDFlattenerExpT.h:45

Enumeration for setting the compression scheme for the Flattened Monochrome images.

Values
kPDFlattenerMonoCCITTGroup3Compression = 0
—
kPDFlattenerMonoCCITTGroup4Compression = 1
—
kPDFlattenerMonoZipCompression = 2
—
kPDFlattenerMonoRunLengthCompression = 3
—
Used In
PDFlattenerUserParamsRec

PDFlattenerQualitySetting

PDFlattenerExpT.h:55

Enumeration for setting the Quality setting for the JPEG or JPEG2000 images.

Values
kPDFlattenerMinimum = 0
—
kPDFlattenerLow = 1
—
kPDFlattenerMedium = 2
—
kPDFlattenerHigh = 3
—
kPDFlattenerMaximum = 4
—
kPDFlattenerJpeg2000Lossless = 5
—
Used In
PDFlattenerUserParamsRec

kPDFlattenerFlags

PDFlattenerExpT.h:184
Values
kPDFlattenerCompressColorImagesZIP = 0x01
—

Setting this flag will choose the ZIP compression scheme (Flate encoding) for compressing the color images. Otherwise we will stick to the current default behavior and try to use JPEG compression wherever possible.

pdfprocessor

16 items

Functions(6)

PDFProcessorConvertAndSaveToPDFA

ASBool PDFProcessorConvertAndSaveToPDFA(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams)
PDFProcessorProcs.h:36

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

Parameters
srcPDDoc: PDDoc

Input PDDoc to be converted.

outputFilePath: ASPathName

Output file path complete with the name of the PDF file we want to save the output to.

outputFileSystem: ASFileSys
option: PDFProcessorPDFAConversionOption

Define the PDF/A conversion option.

userParams: PDFProcessorPDFAConvertParams

Parameters to control the conversion. @Return True if conversion is successful. Will throw an exception in case of errors.

Returns
ASBool

PDFProcessorConvertAndSaveToPDFX

ASBool PDFProcessorConvertAndSaveToPDFX(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams)
PDFProcessorProcs.h:66

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

Parameters
srcPDDoc: PDDoc

Input PDDoc to be converted.

outputFilePath: ASPathName

Output file path complete with the name of the PDF file we want to save the output to.

outputFileSystem: ASFileSys
option: PDFProcessorPDFXConversionOption

Define the PDF/X conversion option.

userParams: PDFProcessorPDFXConvertParams

Parameters to control the conversion. @Return True if conversion is successful. Will throw an exception in case of errors.

Returns
ASBool

PDFProcessorConvertToPDFA

ASBool PDFProcessorConvertToPDFA(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams, PDDocSaveParams outSaveParams)
PDFProcessorProcs.h:48

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

Parameters
srcPDDoc: PDDoc

Input PDDoc to be converted.

outPDDoc: PDDoc *
option: PDFProcessorPDFAConversionOption

Define the PDF/A conversion option.

userParams: PDFProcessorPDFAConvertParams

Parameters to control the conversion.

outSaveParams: PDDocSaveParams
Returns
ASBool

PDFProcessorConvertToPDFX

ASBool PDFProcessorConvertToPDFX(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams, PDDocSaveParams outSaveParams)
PDFProcessorProcs.h:78

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

Parameters
srcPDDoc: PDDoc

Input PDDoc to be converted.

outPDDoc: PDDoc *
option: PDFProcessorPDFXConversionOption

Define the PDF/X conversion option.

userParams: PDFProcessorPDFXConvertParams

Parameters to control the conversion.

outSaveParams: PDDocSaveParams
Returns
ASBool

Typedefs(1)

Structures(4)

PDFProcessorPDFAConvertParamsRec

struct PDFProcessorPDFAConvertParamsRec
PDFProcessorExpT.h:171

Structure to Control the PDF/A Processing.

Fields
size: ASSize_t

The size of the structure. Set it to sizeof(PDFProcessorRec).

removeAllAnnotations: ASBool

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.

noRasterizationOnFontErrors: ASBool

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.

abortIfXFAPresent: ASBool

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.

colorCompression: PDFProcessorColorCompressionSet

Color Compression Setting for Color Images. NOTE: This setting will be honored for images when possible, in some cases however when not supported Images will default to Flate compression.

grayCompression: PDFProcessorGrayscaleCompressionSet

Color Compression Setting for Grayscale Images. NOTE: This setting will be honored for images when possible, in some cases however when not supported Images will default to Flate compression.

monoCompression: PDFProcessorMonochromeCompressionSet

Compression Setting for Monochrome Images.

progMon: PDFProcessorProgressMon

Client registered progress monitor callback which will be called to report the progress.

progMonData: void *

Client registered data sent back along with the progress monitor callback.

noValidationErrors: ASBool

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.

rasterizationResolution: ASUns16

When this value is zero, we will rasterize at 72 DPI (Legacy Behaviour). Otherwise, we will interpret the value as the desired resolution.

OutputIntentName: ASText

Add an ASText object, which, when present, will carry the name of a profile to use as output intent

Note: If this is specified, it must include the description of a valid ICC profile, which is a CMYK space for PDF/X-1a or a CMYK or RGB space for PDF/X-3.

validateImplementationLimitsOfDocument: ASBool

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.

Note: : It's recommended noValidationErrors be set to false, noRasterizationOnFontErrors be set to true, and validateImplementationLimitsOfDocument be set to true for getting the best quality output that adheres to the specification.

customOutputIntentProfile: AC_Profile

Specify to use a custom ICC profile for the /OutputIntent, when specified the OutputIntentName member is ignored. NOTE: The ICC profile must be valid and match the target conversion option's underlying space.

PDFProcessorPDFXConvertParamsRec

struct PDFProcessorPDFXConvertParamsRec
PDFProcessorExpT.h:268

Structure to Control the PDF/X Processing.

Fields
size: ASSize_t

The size of the structure. Set it to sizeof(PDFProcessorRec).

removeAllAnnotations: ASBool

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.

abortIfXFAPresent: ASBool

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.

colorCompression: PDFProcessorColorCompressionSet

Color Compression Setting for Color Images.

grayCompression: PDFProcessorGrayscaleCompressionSet

Compression Setting for Grayscale Images.

monoCompression: PDFProcessorMonochromeCompressionSet

Compression Setting for Monochrome Images.

progMon: PDFProcessorProgressMon

Client registered progress monitor callback which will be called to report the progress.

progMonData: void *

Client registered data sent back along with the progress monitor callback.

OutputIntentName: ASText

Add an ASText object, which, when present, will carry the name of a profile to use as output intent

Note: If this is specified, it must include the description of a valid ICC profile, which is a CMYK space.

noValidationErrors: ASBool

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.

ignoreColorConversion: ASBool

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.

destOutputProfileURL: ASText

The URL from which the output intent ICC profile can be retrieved, required by kPDFProcessorConvertToPDFX5pg2010 and ignored by every other conversion option. PDF/X-4p, which PDF/X-5pg builds on, replaces the embedded DestOutputProfile with a DestOutputProfileRef whose URLS array names where the profile lives (ISO 15930-7:2010, Annex A.2). A URL cannot be inferred from the source document, so a PDF/X-5pg conversion raises an error when this is absent.

destOutputProfilePath: ASPathName

A local copy of the output intent ICC profile, used only to derive the DestOutputProfileRef values that ISO 15930-7:2010, Annex A.2 requires: ProfileName, ProfileCS, ICCVersion, the CheckSum, and for PDF/X-5n the ColorantTable. The profile itself is not embedded.

kPDFProcessorConvertToPDFX5n2010 requires this, because the PDF Reference forbids embedding an n-colorant profile, leaving no in-document copy to read. For kPDFProcessorConvertToPDFX5pg2010 it is optional: when absent the embedded profile the conversion produced is used instead.

Enums(5)

PDFProcessorPDFAConversionOption

PDFProcessorExpT.h:33

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

Values
kPDFProcessorConvertToPDFA1aRGB = 0
—

Convert to PDF/A-1a RGB

kPDFProcessorConvertToPDFA1aCMYK = 1
—

Convert to PDF/A-1a CMYK

kPDFProcessorConvertToPDFA1bRGB = 2
—

Convert to PDF/A-1b RGB

kPDFProcessorConvertToPDFA1bCMYK = 3
—

Convert to PDF/A-1b CMYK

kPDFProcessorConvertToPDFA2aRGB = 4
—

Convert to PDF/A-2a RGB

kPDFProcessorConvertToPDFA2aCMYK = 5
—

Convert to PDF/A-2a CMYK

kPDFProcessorConvertToPDFA2bRGB = 6
—

Convert to PDF/A-2b RGB

kPDFProcessorConvertToPDFA2bCMYK = 7
—

Convert to PDF/A-2b CMYK

kPDFProcessorConvertToPDFA2uRGB = 8
—

Convert to PDF/A-2u RGB

kPDFProcessorConvertToPDFA2uCMYK = 9
—

Convert to PDF/A-2u CMYK

kPDFProcessorConvertToPDFA3aRGB = 10
—

Convert to PDF/A-3a RGB

kPDFProcessorConvertToPDFA3aCMYK = 11
—

Convert to PDF/A-3a CMYK

kPDFProcessorConvertToPDFA3bRGB = 12
—

Convert to PDF/A-3b RGB

kPDFProcessorConvertToPDFA3bCMYK = 13
—

Convert to PDF/A-3b CMYK

kPDFProcessorConvertToPDFA3uRGB = 14
—

Convert to PDF/A-3u RGB

kPDFProcessorConvertToPDFA3uCMYK = 15
—

Convert to PDF/A-3u CMYK

kPDFProcessorConvertToPDFA4RGB = 16
—

Convert to PDF/A-4 RGB

kPDFProcessorConvertToPDFA4CMYK = 17
—

Convert to PDF/A-4 CMYK

kPDFProcessorConvertToPDFA4eRGB = 18
—

Convert to PDF/A-4e RGB

kPDFProcessorConvertToPDFA4eCMYK = 19
—

Convert to PDF/A-4e CMYK

kPDFProcessorConvertToPDFA4fRGB = 20
—

Convert to PDF/A-4f RGB

kPDFProcessorConvertToPDFA4fCMYK = 21
—

Convert to PDF/A-4f CMYK

PDFProcessorPDFXConversionOption

PDFProcessorExpT.h:90

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

Values
kPDFProcessorConvertToPDFX1a2001 = 0
—

Convert to PDF/X-1a 2001

kPDFProcessorConvertToPDFX32003 = 1
—

Convert to PDF/X-3 2003

kPDFProcessorConvertToPDFX42010 = 2
—

Convert to PDF/X-4 2010

kPDFProcessorConvertToPDFX62020 = 3
—

Convert to PDF/X-6 2020

kPDFProcessorConvertToPDFX5g2010 = 4
—

Convert to PDF/X-5g 2010, the PDF/X-5 conformance level for externally referenced graphical content (ISO 15930-8, 8.1).

kPDFProcessorConvertToPDFX5pg2010 = 5
—

Convert to PDF/X-5pg 2010, the PDF/X-5 conformance level combining externally referenced graphical content with an externally referenced output intent profile (ISO 15930-8, Clause 9). Requires destOutputProfileURL.

kPDFProcessorConvertToPDFX5n2010 = 6
—

Convert to PDF/X-5n 2010, the PDF/X-5 conformance level for an n-colorant printing condition (ISO 15930-8, Clause 7). Requires destOutputProfilePath and destOutputProfileURL naming an xCLR ICC profile; the PDF Reference forbids embedding an n-colorant profile, so it can only ever be referenced.

kPDFProcessorConvertToPDFX4p2010 = 7
—

Convert to PDF/X-4p 2010 (ISO 15930-7, Annex A): PDF/X-4 conformance with the output intent ICC profile referenced externally rather than embedded. Requires destOutputProfileURL.

webtopdf

28 items

Functions(11)

WebToPDFConvertFileTree

WebToPDFResultCode WebToPDFConvertFileTree(const char *rootPath, const char *indexFile, const char *outputPath, WebToPDFParams params)
WebToPDFProcs.h:85

Convert a local directory to PDF.

Parameters
rootPath: const char *

Path to the root directory (UTF-8 encoded).

indexFile: const char *

Entry-point file name (e.g. "index.html"), or NULL for auto-detect.

outputPath: const char *

Path to the output PDF file (UTF-8 encoded).

params: WebToPDFParams

Conversion parameters, or NULL for defaults.

Returns
WebToPDFResultCode

A WebToPDFResultCode indicating success or failure.

WebToPDFConvertHTML

WebToPDFResultCode WebToPDFConvertHTML(const char *htmlContent, const char *baseURL, const char *outputPath, WebToPDFParams params)
WebToPDFProcs.h:72

Convert an HTML string to PDF.

Parameters
htmlContent: const char *

The HTML content to convert (UTF-8 encoded).

baseURL: const char *

Base URL for resolving relative resources, or NULL.

outputPath: const char *

Path to the output PDF file (UTF-8 encoded).

params: WebToPDFParams

Conversion parameters, or NULL for defaults.

Returns
WebToPDFResultCode

A WebToPDFResultCode indicating success or failure.

WebToPDFGetLastError

ASInt32 WebToPDFGetLastError(char *buffer, ASInt32 bufferSize)
WebToPDFProcs.h:96

Get a detailed error message from the last failed operation.

Parameters
buffer: char *

Buffer to receive the error message.

bufferSize: ASInt32

Size of buffer in bytes.

Returns
ASInt32

The actual length of the error message (may exceed bufferSize if truncated).

WebToPDFInitialize

ASBool WebToPDFInitialize(void)
WebToPDFProcs.h:24

Initialize the WebToPDF plugin. Must be called once before any other WebToPDF functions. Sets up the Chromium Embedded Framework and internal plugin state.

Parameters
: void
Returns
ASBool

true on success, false on failure.

WebToPDFShutdown

void WebToPDFShutdown(void)
WebToPDFProcs.h:121

Permanently shut down the plugin's CEF runtime (final, synchronous). Joins the Chromium thread pool via CefShutdown() before returning. Unlike WebToPDFTerminate() (a repeatable per-session no-op), this is one-shot. Call once, at end-of-life, before the host unloads the plugin.

Parameters
: void
Returns
void

WebToPDFTerminate

void WebToPDFTerminate(void)
WebToPDFProcs.h:32

Terminate the WebToPDF plugin. Must be called when done using the plugin to release all resources, including the CEF runtime.

Parameters
: void
Returns
void

Typedefs(4)

ASBool

typedef unsigned short ASBool
WebToPDFExpT.h:54
Used In
ASFileSysItemPropsRecDLPDEImageExportParamsJPXCSEnumAttrsOPI13dictOPI20dictOfficeToPDFParamsRecOptimizedFontRecPDApplyRedactionParamsRecPDCollectionFieldRecPDCollectionSchemaSortPairRecPDColorConvertActionRecPDColorConvertActionRecExPDColorConvertParamsRecExPDDocAddWatermarkParamsRecPDDocCopyParamsRecPDDocOpenParamsRecPDDocSaveParamsRecPDDocTextFinderConfigRecPDEFontCreateParamsRecPDFLPrintUserParamsRecPDFLPrintUserParamsRecExPDFOptimizerReportRecPDFProcessorPDFAConvertParamsRecPDFProcessorPDFXConvertParamsRecPDFlattenRecPDHostSepsSpecRecPDImageAttrsPDPageDrawMParamsRecPDPageDrawWParamsRecPDPageEnumInksParamRecPDPageInkRecPDPrintClientRecPDPrintFontArrayPDPrintFontRecPDPrintParamsRecPDRedactParamsRecPDSMCInfoPDTileRecPDTrapPresetRecPDWordFinderConfigRecStdSecurityDataRec

WebToPDFLogCallback

typedef void(*) WebToPDFLogCallback(ASInt32 level, const char *message, void *clientData)(ASInt32 level, const char *message, void *clientData)
WebToPDFExpT.h:251

Logging callback function prototype. Called to deliver log messages generated during conversion. The callback is invoked on the conversion thread, so implementations should be thread-safe or dispatch to the appropriate thread.

Structures(7)

WebToPDFConversionInfoRec

struct WebToPDFConversionInfoRec
WebToPDFExpT.h:418

Information about a completed conversion. Populated by WebToPDFGetConversionInfo() after a successful conversion. String pointers (title, sourceURL) remain valid until the next conversion call or until the plugin is terminated.

Fields
size: ASSize_t

Structure size for versioning. Set this to sizeof(WebToPDFConversionInfoRec) before calling WebToPDFGetConversionInfo(); only the leading size bytes are written.

pageCount: ASInt32

Number of pages in the output PDF.

conversionTimeMs: ASInt32

Wall-clock conversion time in milliseconds.

title: const char *

Page title extracted from the HTML, or NULL. UTF-8 encoded.

sourceURL: const char *

The resolved source URL that was converted, or NULL. UTF-8 encoded.

WebToPDFMargins

struct WebToPDFMargins
WebToPDFExpT.h:280

Page margins in inches.

Fields
top: double

Top margin in inches.

right: double

Right margin in inches.

bottom: double

Bottom margin in inches.

left: double

Left margin in inches.

WebToPDFPageDimensions

struct WebToPDFPageDimensions
WebToPDFExpT.h:271

Custom page dimensions in points (72 points = 1 inch). Used when WebToPDFParamsRec::pageSize is kWebToPDFPageSizeCustom.

Fields
width: double

Page width in points.

height: double

Page height in points.

WebToPDFParamsRec

struct WebToPDFParamsRec
WebToPDFExpT.h:298

Main parameters structure for web-to-PDF conversion. Clients should call WebToPDFInitParams() to fill this structure with sensible defaults before modifying individual fields. The size field is used for versioning and must always be set to sizeof(WebToPDFParamsRec).

Fields
size: ASSize_t

Structure size for versioning (must be first field).

Set this to sizeof(WebToPDFParamsRec)
before calling WebToPDFInitParams(), and leave it alone afterwards. The struct only ever grows at the end, so this is what lets a library build newer than your headers avoid reading or writing past the end of your allocation: it fills and consults only the leading size bytes and applies its own defaults to anything beyond them. A value too small to describe any released layout makes the conversion functions fail with kWebToPDFErrorInvalidParams.

Enums(6)

WebToPDFDownsamplingDPI

WebToPDFExpT.h:209

Downsampling resolution options for raster images in the output PDF. Images whose native resolution exceeds the chosen threshold are downsampled to reduce file size.

Values
kWebToPDFDPIDisabled =
 -1
—

Disable downsampling; preserve original resolution.

kWebToPDFDPI300 = 0
—

Downsample to 300 DPI (default).

kWebToPDFDPI75 = 1
—

Downsample to 75 DPI (screen quality).

kWebToPDFDPI150 = 2
—

Downsample to 150 DPI.

kWebToPDFDPI600 = 3
—

Downsample to 600 DPI (high quality print).

kWebToPDFDPI1200 = 4
—

Downsample to 1200 DPI (very high quality).

WebToPDFImageCompression

WebToPDFExpT.h:195

Image compression modes for raster images embedded in the output PDF. DeprecatedNot supported and has no effect. Conversion is performed by the CEF PDF generator, which exposes no image-compression control, so the compression of the raster images Chromium embeds cannot be selected. The enum is retained so the ABI stays compatible. Setting anything other than kWebToPDFCompressionJPEG emits a warning through WebToPDFParamsRec::logCallback.

Values
kWebToPDFCompressionJPEG =
 0
—

Lossy JPEG compression (smaller file size). Not honored.

kWebToPDFCompressionLossless
—

Lossless compression (larger file, pixel-perfect). Not honored.

WebToPDFPageOrientation

WebToPDFExpT.h:160

Page orientation for the output PDF.

Values
kWebToPDFOrientationPortrait =
 0
—

Portrait orientation (taller than wide).

kWebToPDFOrientationLandscape
—

Landscape orientation (wider than tall).

WebToPDFPageSize

WebToPDFExpT.h:173

Standard page sizes for the output PDF. Choose kWebToPDFPageSizeCustom and populate WebToPDFParamsRec::customPageSize to specify exact dimensions in points.

Values
kWebToPDFPageSizeLetter = 0
—

US Letter (8.5 x 11 in).

kWebToPDFPageSizeLegal = 1
—

US Legal (8.5 x 14 in).

kWebToPDFPageSizeLedger = 2
—

US Ledger / Tabloid (11 x 17 in).

kWebToPDFPageSizeA3 = 3
—

ISO A3 (297 x 420 mm).

kWebToPDFPageSizeA4 = 4
—

ISO A4 (210 x 297 mm).

kWebToPDFPageSizeA5 = 5
—

ISO A5 (148 x 210 mm).

kWebToPDFPageSizeCustom = 6
—

Custom dimensions specified in WebToPDFParamsRec::customPageSize.

WebToPDFResultCode

WebToPDFExpT.h:117

Result codes returned by WebToPDF conversion operations. Every conversion function returns one of these codes to indicate success or the specific category of failure. Use WebToPDFGetLastError() to obtain a human-readable description when a non-success code is returned.

Values
kWebToPDFSuccess = 0
—

Operation completed successfully.

kWebToPDFErrorBadPath =
 1
—

An input or output file path is invalid or inaccessible.

kWebToPDFErrorConverterFailure =
 2
—

The CEF rendering engine reported an internal error.

kWebToPDFErrorCEFInitFailed = 3
—

CEF could not be initialized (missing binaries, sandbox failure, etc.).

kWebToPDFErrorInvalidURL =
 4
—

The supplied URL is malformed or uses an unsupported scheme.

kWebToPDFErrorTimeout =
 5
—

The conversion exceeded the configured timeout.

kWebToPDFErrorOutputFailed =
 6
—

The output PDF file could not be written.

kWebToPDFErrorNotInitialized =
 7
—

WebToPDFInitialize() has not been called yet.

kWebToPDFErrorCancelled =
 8
—

The conversion was cancelled via the progress callback.

kWebToPDFErrorInvalidParams =
 9
—

The parameter block's size field is not a size this library can interpret.

WebToPDFViewportSize

WebToPDFExpT.h:148

Viewport size presets used when rendering web content. Controls the virtual browser viewport dimensions during rendering. Choose kWebToPDFViewportCustom and populate WebToPDFParamsRec::customViewport to specify exact pixel dimensions.

Values
kWebToPDFViewportDesktop = 0
—

Desktop viewport (default 1280x1024).

kWebToPDFViewportMobile = 1
—

Mobile viewport (e.g. 375x812).

kWebToPDFViewportTablet = 2
—

Tablet viewport (e.g. 768x1024).

kWebToPDFViewportCustom = 3
—

Custom dimensions specified in WebToPDFParamsRec::customViewport.

xps2pdf

3 items

Functions(3)

XPS2PDFConvert

ASInt32 XPS2PDFConvert(ASCab inSettings, ASInt32 conversionFlags, ASPathName inPath, ASFileSys inFileSys, PDDoc *outPDDoc, void *clientData)
XPS2PDFProcs.h:37

Converts aa XPS file into a PDF file.

Parameters
inSettings: ASCab
conversionFlags: ASInt32

Kept for future use. Default to 0.

inPath: ASPathName

Folder path where the input XPS files are kept.

inFileSys: ASFileSys

File system

outPDDoc: PDDoc *

The output PDDoc which we want to make from XPS.

clientData: void *

Kept for future use. Default to NULL.

Returns
ASInt32