API reference

PDF/A & Conformance

52 functions. Every declaration on the detail pages is extracted from the shipped bindings.

Content Creation

pdfAddActionToObj Attach an already-created action ([Actions & Named Destinations](../V03_CoreSDK/E07_ActionsAndNamedDestinations.md)) to an object's
pdfAddAnnotToPage Attach an already-created annotation/field handle to a
pdfAddArticle Add an article thread bead (a linked reading-order region)
pdfAddBookmark Three ABI generations of the same bookmark-creation
pdfAddBookmarkEx Three ABI generations of the same bookmark-creation
pdfAddBookmarkEx2 Three ABI generations of the same bookmark-creation
pdfAddButtonImage Three source variants of the same real feature — give a
pdfAddButtonImageEx Three source variants of the same real feature — give a
pdfAddButtonImageEx2 Three source variants of the same real feature — give a
pdfAddClassMapEntry Real tagged-PDF structure-tree mechanisms: /RoleMap
pdfAddContinueText Write one more line of text at the "continue text" cursor
pdfAddDeviceNProcessColorants Attach the PDF 2.0/DeviceN /Process (which real process
pdfAddDeviceNSeparations Attach the PDF 2.0/DeviceN /Process (which real process
pdfAddDPartNode Add a /DPart (Document Part, PDF 2.0's hierarchical
pdfAddFileComment pdfAddFileComment appends a free-text comment line to a
pdfAddImage The lowest-level raw image insertion primitive — embed a
pdfAddInkList Append one stroke (a point list) to an Ink annotation's
pdfAddJavaScript Add a document-level named JavaScript entry (the
pdfAddLayerToDisplTree pdfAddLayerToDisplTree builds a node in the OCG UI
pdfAddLGIDictToPage Attach an /LGI (Legal Government/geospatial Information,
pdfAddMaskImage Attach an explicit stencil/soft-mask buffer (/Mask or
pdfAddObjectToLayer pdfAddLayerToDisplTree builds a node in the OCG UI
pdfAddObjRefToStruct Bind an annotation to the currently-open structure element
pdfAddOCGRadioGroup Declare a set of optional-content groups as a mutually
pdfAddOCGToAppEvent Subscribe an OCG to one or more application events
pdfAddOutputIntent Add a real /OutputIntent — the standard PDF (and, more
pdfAddOutputIntentEx Add a real /OutputIntent — the standard PDF (and, more
pdfAddPageLabel Add a /PageLabels numbering-style range starting at a
pdfAddRasImage Place an IRAS rasterizer's already-rendered RGB buffer
pdfAddRichMediaAsset Add an embedded asset (e.g. a 3D model, image, or other
pdfAddRoleMap Real tagged-PDF structure-tree mechanisms: /RoleMap
pdfAddRoleMapEntry Real tagged-PDF structure-tree mechanisms: /RoleMap
pdfAddSVGAnnotationFromFile Embed an SVG file (rendered directly to the page) or a SWF
pdfAddSWFAnnotationFromFile Embed an SVG file (rendered directly to the page) or a SWF
pdfAddToFileList Append a file name string to a caller-named, general-purpose
pdfAddValToChoiceField Append one (export value, display value) option pair to

Conversion

pdfConvertFile One-call file-to-file conversion of any loadable PDF into

Core

pdfAnalyseFile pdfAnalyseFile reads and inspects an arbitrary,
pdfAnsiStringResultLength pdfAnalyseFile reads and inspects an arbitrary,
pdfAppend Fully documented elsewhere — cross-referenced here only to satisfy this volume's own completeness (see [Bookmarks, Articles, Page Labels, and Structure-Tree Binding](E01_BookmarksArticlesPageLabelsAndStructureBinding.md)'s scope note: these three happen to share the pdfA-prefix naming accident with this volume's real content, but their authoritative homes are in V17):
pdfApplyAppEvent Apply an optional-content application-event's visibility
pdfApplyPattern Set the current fill or stroke color to an already-created
pdfApplyShading Set the current fill or stroke color to an already-created
pdfAssociateEmbFile pdfAddFileComment appends a free-text comment line to a
pdfAttachFile Fully documented elsewhere — cross-referenced here only to satisfy this volume's own completeness (see [Bookmarks, Articles, Page Labels, and Structure-Tree Binding](E01_BookmarksArticlesPageLabelsAndStructureBinding.md)'s scope note: these three happen to share the pdfA-prefix naming accident with this volume's real content, but their authoritative homes are in V17):
pdfAttachFileEx Fully documented elsewhere — cross-referenced here only to satisfy this volume's own completeness (see [Bookmarks, Articles, Page Labels, and Structure-Tree Binding](E01_BookmarksArticlesPageLabelsAndStructureBinding.md)'s scope note: these three happen to share the pdfA-prefix naming accident with this volume's real content, but their authoritative homes are in V17):
pdfAutoTemplate Register an already-created template ([Templates, Content Capture, and Soft Masks](../V03_CoreSDK/E19_TemplatesCaptureAndSoftMasks.md)) to be

Forms

pdfAddFieldToFormAction Add a field to an already-created SubmitForm/
pdfAddFieldToHideAction Add a field to an already-created SubmitForm/

Getters

pdfGetConformanceViolation Read back the real violation list pdfCheckConformance's
pdfGetConformanceViolationCount Read back the real violation list pdfCheckConformance's

Validation

pdfCheckConformance A dual-purpose function: (1) arm the output