SavePreflightReportEx

Compliance, Document inspection

Description

Creates a preflight report with CreatePreflightReportEx and writes it to a UTF-8 file. Use this overload when the output should be JSON, HTML, or CSV instead of the default plain-text report.

Syntax

Delphi

function TPDFlib.SavePreflightReportEx(const InputFileName, Password, ReportFileName: WideString; ComplianceTests, Options, ReportFormat: Integer): Integer;

Parameters

InputFileName	Full path of the PDF file to validate.
Password	Password used to open the file. Pass an empty string for unencrypted documents.
ReportFileName	Destination report path. Parent directories are created automatically. Passing an empty value returns `0`.
ComplianceTests	Bit mask selecting which checks to include: `1` for PDF/A, `2` for PDF/UA-1, `3` or `0` for both.
Options	Bit flags passed through to each selected compliance check. Pass `1` to stop each check after its first issue.
ReportFormat	Output format selector: `0` for text, `1` for JSON, `2` for HTML, or `3` for CSV.

Return values

0	The report file name was empty.
1	The report was generated and written successfully.

Remarks

The report is generated by CreatePreflightReportEx and then saved as UTF-8. File-open, validation, directory-creation, and write errors are surfaced as exceptions from the underlying file and compliance-check paths; the return value only distinguishes an empty destination path from a generated report.

For the report-format contract, command-line demo, batch mode, and comparison workflow, see Preflight Reports.

Example

PDF.SavePreflightReportEx('output.pdf', '', 'output-preflight.json', 1 or 2, 0, 1);
PDF.SavePreflightReportEx('output.pdf', '', 'output-preflight.html', 1 or 2, 0, 2);
PDF.SavePreflightReportEx('output.pdf', '', 'output-preflight.csv', 1 or 2, 0, 3);