THotPDF Preflight API Map

This page is generated from Lib\HPDFDoc.pas by tools\build_preflight_api_map.py. It lists the public preflight entry points, report format values, profile fields, and diagnostic names that have an ISO or implementation reference mapping.

Output Formats

pfText, pfJSON, pfHTML

Profile Record

Field	Type
DisableChecks	AnsiString
DisableWarnings	AnsiString
DisableHints	Boolean

Public API

Name	Kind	Signature
`CreatePreflightReport`	function	`function CreatePreflightReport(const SourceFile: TFileName): AnsiString;`
`CreatePreflightReport`	function	`function CreatePreflightReport(const SourceFile: TFileName;`
`SavePreflightReport`	procedure	`procedure SavePreflightReport(const SourceFile: TFileName;`
`SavePreflightReport`	procedure	`procedure SavePreflightReport(const SourceFile: TFileName;`
`CreatePreflightReport`	function	`function CreatePreflightReport(const SourceFile: TFileName;`
`SavePreflightReport`	procedure	`procedure SavePreflightReport(const SourceFile: TFileName;`
`ValidatePDFVT`	function	`function ValidatePDFVT(const SourceFile: TFileName;`
`ValidatePDFVT`	function	`function ValidatePDFVT(const SourceFile: TFileName;`
`EmbedPreflightReportInPDF`	procedure	`procedure EmbedPreflightReportInPDF(const SourceFile: TFileName;`
`EmbedPreflightReportInPDF`	procedure	`procedure EmbedPreflightReportInPDF(const SourceFile: TFileName;`
`LoadAndValidatePreflightReport`	function	`function LoadAndValidatePreflightReport(const EmbeddedFile : TFileName;`
`LoadAndValidatePreflightReport`	function	`function LoadAndValidatePreflightReport(const EmbeddedFile : TFileName;`
`ComparePreflightReports`	function	`function ComparePreflightReports(const ReportA: AnsiString;`
`RepairPDFFromPreflightReport`	function	`function RepairPDFFromPreflightReport(const SourceFile: TFileName;`
`RepairPDFFromPreflightReport`	function	`function RepairPDFFromPreflightReport(const SourceFile: TFileName;`
`AggregatePreflightReports`	function	`function AggregatePreflightReports(const Reports: array of AnsiString): AnsiString;`
`LoadPreflightProfile`	function	`function LoadPreflightProfile(const ProfileFile: TFileName): THPDFPreflightProfile;`
`ApplyPreflightProfile`	function	`function ApplyPreflightProfile(const Report : AnsiString;`
`ValidatePreflightProfile`	function	`function ValidatePreflightProfile(const Profile: THPDFPreflightProfile;`
`GetBuiltInPreflightProfile`	function	`function GetBuiltInPreflightProfile(const Name: AnsiString): THPDFPreflightProfile;`
`SavePreflightProfile`	procedure	`procedure SavePreflightProfile(const Profile : THPDFPreflightProfile;`
`CreatePreflightReportWithProfile`	function	`function CreatePreflightReportWithProfile(const SourceFile : TFileName;`
`MergePreflightProfiles`	function	`function MergePreflightProfiles(const A, B: THPDFPreflightProfile): THPDFPreflightProfile;`
`DiffPreflightProfiles`	function	`function DiffPreflightProfiles(const A, B : THPDFPreflightProfile;`
`EmbedPreflightReportAsXMP`	procedure	`procedure EmbedPreflightReportAsXMP(const SourceFile: TFileName;`
`EmbedPreflightReportAsXMP`	procedure	`procedure EmbedPreflightReportAsXMP(const SourceFile: TFileName;`
`ConvertPreflightReportToVeraPDFStyle`	function	`function ConvertPreflightReportToVeraPDFStyle(const Report: AnsiString): AnsiString;`

Diagnostic Name Map

Name	Category	Reference
`Header`	Check	ISO 32000-1 sec 7.5.2
`EOF`	Check	ISO 32000-1 sec 7.5.5
`EOFNearEnd`	Check	ISO 32000-1 sec 7.5.5
`StartXRef`	Check	ISO 32000-1 sec 7.5.5
`StartXRefOffset`	Check	ISO 32000-1 sec 7.5.5
`StartXRefTarget`	Check	ISO 32000-1 sec 7.5.4 / 7.5.8
`RevisionMarkersBalanced`	Check	ISO 32000-1 sec 7.5.6
`LastStartXRefBeforeEOF`	Check	ISO 32000-1 sec 7.5.5
`Trailer`	Check	ISO 32000-1 sec 7.5.5
`XRefAvailable`	Check	ISO 32000-1 sec 7.5.4
`LoadablePages`	Check	ISO 32000-1 sec 7.7.3
`NotEncrypted`	Check	ISO 32000-1 sec 7.6
`Catalog`	Check	ISO 32000-1 sec 7.7.2
`Pages`	Check	ISO 32000-1 sec 7.7.3
`Page`	Check	ISO 32000-1 sec 7.7.3.3
`MediaBox`	Check	ISO 32000-1 sec 14.11.2
`InfoDictionary`	Check	ISO 32000-1 sec 14.3.3
`RootReference`	Check	ISO 32000-1 sec 7.5.5
`ObjectNumbersUnique`	Check	ISO 32000-1 sec 7.3.10
`PageTreeCountMatchesLoadablePages`	Check	ISO 32000-1 sec 7.7.3
`PageObjectsMatchLoadablePages`	Check	ISO 32000-1 sec 7.7.3
`StreamPairsBalanced`	Check	ISO 32000-1 sec 7.3.8
`StreamLengthsAvailable`	Check	ISO 32000-1 sec 7.3.8.2
`XRefRowsValid`	Check	ISO 32000-1 sec 7.5.4
`XRefCoversObjects`	Check	ISO 32000-1 sec 7.5.4
`TrailerSizeCoversObjects`	Check	ISO 32000-1 sec 7.5.5
`TrailerRootPresent`	Check	ISO 32000-1 sec 7.5.5
`TrailerRootObjectDefined`	Check	ISO 32000-1 sec 7.5.5
`TrailerRootObjectIsCatalog`	Check	ISO 32000-1 sec 7.5.5 / 7.7.2
`TrailerInfoObjectDefined`	Check	ISO 32000-1 sec 7.5.5
`TrailerIDPairPresent`	Check	ISO 32000-1 sec 14.4
`FontsHaveEmbeddedPrograms`	Check	ISO 32000-1 sec 9.9
`AnnotationCountConsistent`	Check	ISO 32000-1 sec 12.5
`PDFAClaimed`	Hint	ISO 19005-1 / 19005-2 / 19005-3
`PDFAPart`	Hint	ISO 19005 part identifier
`PDFAConformance`	Hint	ISO 19005 conformance level
`PDFXClaimed`	Hint	ISO 15930
`PDFUAClaimed`	Hint	ISO 14289-1
`TaggedPDF`	Hint	ISO 32000-1 sec 14.7
`HasTransparency`	Hint	ISO 32000-1 sec 11
`JavaScript`	Warning	ISO 32000-1 sec 12.6.4.16
`LaunchAction`	Warning	ISO 32000-1 sec 12.6.4.5
`OpenAction`	Warning	ISO 32000-1 sec 12.3.4
`AdditionalActions`	Warning	ISO 32000-1 sec 12.6.3
`EmbeddedFile`	Warning	ISO 32000-1 sec 7.11.4
`RichMedia`	Warning	ISO 32000-1 sec 13.6
`GoToRAction`	Warning	ISO 32000-1 sec 12.6.4.3
`GoToEAction`	Warning	ISO 32000-1 sec 12.6.4.4
`ThreadAction`	Warning	ISO 32000-1 sec 12.6.4.6
`URIAction`	Warning	ISO 32000-1 sec 12.6.4.7
`SoundAction`	Warning	ISO 32000-1 sec 12.6.4.8
`MovieAction`	Warning	ISO 32000-1 sec 12.6.4.9
`HideAction`	Warning	ISO 32000-1 sec 12.6.4.10
`NamedAction`	Warning	ISO 32000-1 sec 12.6.4.11
`SubmitFormAction`	Warning	ISO 32000-1 sec 12.7.5.2
`ResetFormAction`	Warning	ISO 32000-1 sec 12.7.5.3
`ImportDataAction`	Warning	ISO 32000-1 sec 12.7.5.4
`SetOCGStateAction`	Warning	ISO 32000-1 sec 12.6.4.12
`RenditionAction`	Warning	ISO 32000-1 sec 12.6.4.13
`TransAction`	Warning	ISO 32000-1 sec 12.6.4.14
`GoTo3DViewAction`	Warning	ISO 32000-1 sec 12.6.4.15
`DuplicateObjectList`	Info	ISO 32000-1 sec 7.3.10
`FirstMalformedXRefOffset`	Info	ISO 32000-1 sec 7.5.4
`StreamEndStreamDelta`	Info	ISO 32000-1 sec 7.3.8
`RevisionStartXRefPositions`	Info	ISO 32000-1 sec 7.5.6
`RevisionXRefTargets`	Info	ISO 32000-1 sec 7.5.6
`InputFingerprint`	Info	FNV-1a 64-bit (non-cryptographic)
`ReportFingerprint`	Info	FNV-1a 64-bit (non-cryptographic)
`PDFXVersion`	Hint	ISO 15930-1 / -3 / -4 / -7 / -8
`PDFUAPart`	Hint	ISO 14289 part identifier
`PDFAWithEncryption`	Hint	ISO 19005-1 sec 6.1.10
`PDFAWithJavaScript`	Hint	ISO 19005-1 sec 6.6.2
`PDFA1WithTransparency`	Hint	ISO 19005-1 sec 6.4

Related Topics