CreatePreflightReportEx

Compliance, Document inspection

Description

建立外部 PDF 檔案的預檢報告，並將該報告轉換為要求的輸出格式；這是 CreatePreflightReport (一律傳回純文字報告) 具備格式感知功能的輔助 API

Syntax

Delphi

Function TPDFlib.CreatePreflightReportEx(Const InputFileName, Password: WideString; ComplianceTests, Options, ReportFormat: Integer): WideString;

Parameters

InputFileName	要驗證的 PDF 檔案完整路徑 The file is opened read-only and is not modified.
Password	用於開啟檔案的密碼；對於未加密的文件請傳遞空字串
ComplianceTests	選擇要包含之檢查的位元遮罩：`1` 表示 PDF/A，`2` 表示 PDF/UA-1，`3` 或 `0` 表示兩者皆包含
Options	傳遞給每個選定合規性檢查的位元旗標；傳入 `1` 可在每個檢查發現第一個問題后停止該檢查
ReportFormat	輸出格式選取器： 0 —— 純文字； 1 —— 包含標頭欄位、每個檢查區段、問題陣列和摘要欄位的 JSON 物件； 2 —— 包含已逸出文字報告的獨立 HTML 文件； 3 —— 包含中介資料、選定檢查、問題代碼和訊息以及最終摘要列的 CSV 列

Return value

以選取的格式傳回產生的報告；未知的 ReportFormat 值將折返使用純文字格式

Remarks

JSON、HTML 和 CSV 格式是由 CreatePreflightReport 使用的同一文字報告產生的，因此通過/失敗狀態和問題計數在所有報告格式中保持一致

JSON 物件公開了標頭欄位、sections 陣列、問題字串陣列以及 summary 物件，HTML 形式是一個獨立文件，將文字報告逸出在預先格式化的區塊內，CSV 形式使用固定的 kind,section,status,code,message 欄位，並將中繼資料、檢查狀態、問題列和摘要列分開，以便電子試算表或 CI 剖析

有關完整報告格式的合約與命令列範例，請參閱 Preflight Reports

Example

JsonReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 1);
HtmlReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 2);
CsvReport := PDF.CreatePreflightReportEx('output.pdf', '', 1 or 2, 0, 3);