THotPDF.CreatePreflightReport Method

Provides create preflight report behaviour for the preflight validation workflow. Use it when the surrounding API family needs explicit control over PDF objects, page content, resources, conformance, or diagnostics

Declaration

function CreatePreflightReport(const SourceFile: TFileName; const Password: AnsiString= ''): AnsiString;
function CreatePreflightReport(const SourceFile: TFileName; const Password: AnsiString; const Format: THPDFPreflightFormat): AnsiString;

Unit

HPDFDoc

Parameters

Return value

Returns an AnsiString value

Usage notes

• Use this API in the preflight validation workflow before the affected page, resource, field, or catalog object is finalised
• Keep object names, field names, resource names, and returned handles stable until the document is finalised
• Use profile helpers when report output must be repeatable across batch validation runs
• pfJSON findings expose stable namespaced ruleId values and structured location objects for policy engines and CI gates
• Locations always provide logical scope and path, and include a PDF key, object number, zero-based page index, or byte offset when available
• pfText remains byte-compatible and pfCSV retains the stable category,name,status,value,spec columns

Related APIs

• THotPDF
• THPDFPage
• Contents