CreatePreflightReport
Compliance, Document inspection
Popis
Vytvoří textovou preflight zprávu pro externí PDF soubor spuštěním stávajících kontrol souladu souboru s PDF/A a PDF/UA-1 a naformátováním jejich výsledků do jednoho znovu použitelného těla zprávy. Je to pohodlné API pro případy, kdy aplikace chce čitelnou zprávu, aniž by ručně volala CheckFileCompliance, GetStringListCount, GetStringListItem a ReleaseStringList
Syntaxe
Delphi
Function TPDFlib.CreatePreflightReport(Const InputFileName, Password: WideString; ComplianceTests, Options: Integer): WideString;Parametry
| InputFileName | Úplná cesta k validovanému PDF souboru. Soubor se otevírá jen pro čtení a nemodifikuje se |
|---|---|
| Password | Heslo použité k otevření souboru. U nešifrovaných dokumentů předejte prázdný řetězec |
| ComplianceTests | Bit mask selecting which checks to include. 1 — PDF/A. 2 — PDF/UA-1. 3 — both PDF/A and PDF/UA-1. Passing 0 also runs both checks. |
| Options | Bit flags passed through to each underlying compliance check. 0 — Report every issue found in each selected check. 1 — Stop each selected check after the first issue. |
Návratová hodnota
Vrací textovou zprávu v UTF-16 obsahující hlavičku zprávy, jednu sekci na každou vybranou kontrolu shody a finální souhrn s řádky Total issues a Result
Poznámky
Je-li vybráno více standardů, soubor se parsuje jednou a obě audity sdílejí téhož čtečku, stav zabezpečení, graf objektů dokumentu a cache líných objektů
Report API nenahrazuje dedikovaný externí validátor PDF/A. Zabalí vestavěnou diagnostiku knihovny první linie pro PDF/A a PDF/UA-1 do stabilní zprávy určené aplikaci. Textový, JSON, HTML, nebo CSV výstup potřebujete-li, použijte CreatePreflightReportEx, a potřebujete-li jednotlivá handle seznamů problémů místo formátovaného textu, použijte CheckFileCompliance přímo
Textová zpráva je kanonický zdroj pro každou formátovanou zprávu. Obsahuje nestálá metadata Generated:, cestu Input:, vybrané kontroly, režim sběru problémů, jednu sekci pro každý vybraný test shody a finální souhrn s Total issues a Result
Pro pracovní postupy z příkazového řádku a dávkové sestavy viz Preflight Reports
Příklad
var
Report: WideString;
begin
Report := PDF.CreatePreflightReport('output.pdf', '', 1 or 2, 0);
WriteLn(Report);
end;Viz také
Preflight Reports, CreatePreflightReportEx, SavePreflightReport, ComparePreflightReports, CheckFileCompliance, GetPDFUADiagnostics, SetPDFAMode, SetPDFUAMode