CreatePreflightReportEx
Compliance, Document inspection
Popis
Vytvoří preflight zprávu pro externí PDF soubor a převede ji do požadovaného výstupního formátu. Je to variantou CreatePreflightReport pracující s formáty, zatímco ta vždy vrací textovou zprávu
Syntaxe
Delphi
Function TPDFlib.CreatePreflightReportEx(Const InputFileName, Password: WideString; ComplianceTests, Options, ReportFormat: 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 | Bitová maska určující, které kontroly zahrnout: 1 pro PDF/A, 2 pro PDF/UA-1, 3 nebo 0 pro obě |
| Options | Bit flags passed through to each selected compliance check. Pass 1 to stop each check after its first issue. |
| ReportFormat | Selektor výstupního formátu. 0 — prostý text. 1 — objekt JSON s poli hlavičky, oddíly jednotlivých kontrol, poli problémů a poli souhrnu. 2 — samostatný dokument HTML obsahující escapovaný textový report. 3 — řádky CSV s metadaty, vybranými kontrolami, kódy a zprávami problémů a závěrečnými řádky souhrnu |
Návratová hodnota
Vrací vygenerovanou zprávu ve vybraném formátu. Neznámé hodnoty ReportFormat spadnou na formát prostého textu
Poznámky
Formáty JSON, HTML i CSV se generují ze stejné textové zprávy používané funkcí CreatePreflightReport, takže stav pass/fail i počty problémů zůstávají konzistentní napříč všemi formáty zpráv
JSON objekt vystavuje hlavičková pole, pole sections, pole řetězců problémů a objekt summary. HTML forma je samostatný dokument, který escapuje textovou zprávu v preformátovaném bloku. CSV forma používá pevné sloupce kind,section,status,code,message a odděluje metadata, stav kontrol, řádky problémů a souhrnné řádky pro parsování v tabulkách nebo CI
Úplný kontrakt formátu zpráv a ukázky příkazové řádky najdete v Preflight Reports
Příklad
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);Viz také
Preflight Reports, CreatePreflightReport, SavePreflightReportEx, ComparePreflightReports, CheckFileCompliance