CreatePreflightReport

Overensstemmelse, dokumentinspektion

Beskrivelse

Opretter en preflight-rapport i almindelig tekst for en ekstern PDF-fil ved at køre de eksisterende PDF/A- og PDF/UA-1-filoverensstemmelseskontroller og formatere deres resultater i én genanvendelig rapporttekst. Dette er det praktiske API, der skal bruges, når et program ønsker en menneskeligt læsbar rapport i stedet for manuelt at kalde CheckFileCompliance, GetStringListCount, GetStringListItem og ReleaseStringList.

Syntaks

Delphi

Function TPDFlib.CreatePreflightReport(Const InputFileName, Password: WideString; ComplianceTests, Options: 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, hvilke kontroller der skal medtages. 1 — PDF/A. 2 — PDF/UA-1. 3 — både PDF/A og PDF/UA-1. Angivelse af `0` kører også begge kontroller
Options	Bitflag, der videregives til hver underliggende overensstemmelseskontrol. 0 — Rapportér alle problemer, der findes i hver valgt kontrol. 1 — Stop hver valgt kontrol efter det første problem.

Returværdi

Returnerer en UTF-16-tekstrapport, der indeholder rapportheaderen, én sektion pr. valgt overensstemmelseskontrol og en afsluttende oversigt med linjerne Total issues og Result.

Bemærkninger

Når flere standarder er valgt, fortolkes filen én gang, og begge kontroller deler den samme læser, sikkerhedstilstand, dokumentobjektgraf og dovne objektcache

Rapport-API'en erstatter ikke en dedikeret ekstern PDF/A-validator. Den samler bibliotekets indbyggede førstelinjediagnosticering for PDF/A og PDF/UA-1 i en stabil rapport til programmer. Brug CreatePreflightReportEx, når programmet har brug for tekst-, JSON-, HTML- eller CSV-output, og brug CheckFileCompliance direkte, når det har brug for individuelle greb til problemlister i stedet for formateret tekst

Klartekstrapporten er den kanoniske kilde til alle formaterede rapporter. Den indeholder flygtige Generated:-metadata, en Input:-sti, de valgte kontroller, tilstanden for indsamling af problemer, én sektion for hver valgt overensstemmelsestest og en afsluttende oversigt med Total issues og Result

Se Preflightrapporter for arbejdsgange med kommandolinje og batchrapporter

Eksempel

var
  Report: WideString;
begin
  Report := PDF.CreatePreflightReport('output.pdf', '', 1 or 2, 0);
  WriteLn(Report);
end;

Se også

Preflight Reports, CreatePreflightReportEx, SavePreflightReport, ComparePreflightReports, CheckFileCompliance, GetPDFUADiagnostics, SetPDFAMode, SetPDFUAMode