CreatePreflightReportEx
Overensstemmelse, dokumentinspektion
Beskrivelse
Opretter en preflight-rapport for en ekstern PDF-fil og konverterer rapporten til det ønskede outputformat. Dette er den formatbevidste ledsager til CreatePreflightReport, som altid returnerer rapporten i almindelig tekst.
Syntaks
Delphi
Function TPDFlib.CreatePreflightReportEx(Const InputFileName, Password: WideString; ComplianceTests, Options, ReportFormat: Integer): WideString;Parametre
| InputFileName | Den fulde sti til den PDF-fil, der skal valideres. Filen åbnes skrivebeskyttet og ændres ikke. |
|---|---|
| Password | Adgangskode til åbning af filen. Angiv en tom streng for ukrypterede dokumenter. |
| ComplianceTests | Bitmaske, der vælger de kontroller, som skal medtages: 1 for PDF/A, 2 for PDF/UA-1, 3 eller 0 for begge |
| Options | Bitflag, der videregives til hver valgt overensstemmelseskontrol. Angiv 1 for at stoppe hver kontrol efter dens første problem. |
| ReportFormat | Vælger outputformat. 0 — ren tekst. 1 — JSON-objekt med headerfelter, sektioner pr. kontrol, problemarrays og oversigtsfelter. 2 — selvstændigt HTML-dokument med den undvegne tekstrapport. 3 — CSV-rækker med metadata, valgte kontroller, problemkoder og -meddelelser samt afsluttende oversigtsrækker |
Returværdi
Returnerer den genererede rapport i det valgte format. Ukendte ReportFormat-værdier falder tilbage til formatet med almindelig tekst.
Bemærkninger
Formaterne JSON, HTML og CSV genereres fra den samme tekstrapport, der bruges af CreatePreflightReport, så bestået/ikke bestået-status og problemantal forbliver konsistente på tværs af alle rapportformater.
JSON-objektet viser headerfelter, et sections-array, arrays med problemstrenge og et summary-objekt. HTML-formen er et selvstændigt dokument, der escaper tekstrapporten i en præformateret blok. CSV-formen bruger de faste kolonner kind,section,status,code,message og adskiller metadata, kontrolstatus, problemrækker og oversigtsrækker til fortolkning i regneark eller CI.
Se Preflight-rapporter for hele kontrakten for rapportformatet og eksempler på demokommandoer
Eksempel
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);Se også
Preflight Reports, CreatePreflightReport, SavePreflightReportEx, ComparePreflightReports, CheckFileCompliance