SavePreflightReport
Compliance, Document inspection
Description
使用 CreatePreflightReport 创建纯文本预检报告并将其写入 UTF-8 文本文件;如果输出目录不存在,则会自动创建
Syntax
Delphi
Function TPDFlib.SavePreflightReport(Const InputFileName, Password, ReportFileName: WideString; ComplianceTests, Options: Integer): Integer;
Parameters
| InputFileName | 要验证的 PDF 文件的完整路径 |
|---|---|
| Password | 用于打开文件的密码;对于未加密的文档,传递空字符串 |
| ReportFileName | 目标文本报告路径,会自动创建父目录;传入空值将返回 0 |
| ComplianceTests | 选择包含哪些检查的位掩码:1 表示 PDF/A,2 表示 PDF/UA-1,3 或 0 表示同时进行这两项检查 |
| Options | 传递给每个选定的合规性检查的位标记;传入 1 以便在发现第一个问题后停止每项检查 |
Return values
| 0 | 报告文件名为空 |
|---|---|
| 1 | 报告已成功生成并写入 |
Remarks
当输出应为 JSON、HTML 或 CSV 时,请使用 SavePreflightReportEx;文件打开、验证或写入错误将作为底层文件和合规性检查路径的异常显现出来;在需要进程级退出码的命令行工具或服务中使用它时,请对调用进行包装
Example
if PDF.SavePreflightReport('output.pdf', '', 'output-preflight.txt', 1 or 2, 0) = 1 then
WriteLn('Preflight report saved.');See also
预检报告, SavePreflightReportEx, CreatePreflightReport, ComparePreflightReports, CheckFileCompliance, ReleaseStringList