CreatePreflightReport

Zgodność, Inspekcja dokumentu

Wybór profilu czytnika PDF/UA

Kontrole PDF/UA wybierają część 2, gdy XMP wskazuje pdfuaid:part=2, a w przeciwnym razie zachowują kontrole części 1; opisane tu starsze kontrole PDF/UA-1 nie obejmują automatycznie części 2

Profil PDF/UA-2 implementuje podstawowe kontrole identyfikacji, przestrzeni nazw, ról i struktury; raporty strukturalne używają PDF/UA-2 i ISO 14289-2 oraz ujawniają fullCertification=false i niezweryfikowany zakres

Użyj CheckFilePDFUACompliance lub RunPDFUAValidationPipelineTask, aby wymusić część docelową, oraz GetPDFUAReadValidationCoverageJSON, aby obejrzeć limity możliwości

Opis

Tworzy tekstowy raport kontroli wstępnej dla zewnętrznego pliku PDF, uruchamiając istniejące kontrole zgodności pliku PDF/A i PDF/UA-1 oraz formatując ich wyniki w jednym raporcie wielokrotnego użytku. To wygodny interfejs API dla aplikacji potrzebującej raportu czytelnego dla użytkownika zamiast ręcznych wywołań CheckFileCompliance, GetStringListCount, GetStringListItem i ReleaseStringList.

Składnia

Delphi

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

Parametry

InputFileNamePełna ścieżka pliku PDF do zweryfikowania. Plik jest otwierany tylko do odczytu i nie jest modyfikowany.
PasswordHasło używane do otwarcia pliku. Dla dokumentów niezaszyfrowanych przekaż pusty ciąg.
ComplianceTestsMaska bitowa wybierająca kontrole do uwzględnienia.

1 — PDF/A.
2 — PDF/UA-1.
3 — zarówno PDF/A, jak i PDF/UA-1. Przekazanie 0 również uruchamia obie kontrole.
OptionsFlagi bitowe przekazywane do każdej bazowej kontroli zgodności.

0 — Zgłoś każdy problem znaleziony w każdej wybranej kontroli.
1 — Zatrzymaj każdą wybraną kontrolę po pierwszym problemie.

Wartość zwracana

Zwraca raport tekstowy UTF-16 zawierający nagłówek raportu, po jednej sekcji dla każdej wybranej kontroli zgodności oraz końcowe podsumowanie z wierszami Total issues i Result.

Uwagi

Gdy wybrano wiele standardów, plik jest analizowany raz, a obie kontrole współdzielą ten sam czytnik, stan zabezpieczeń, graf obiektów dokumentu i leniwą pamięć podręczną obiektów

Interfejs API raportów nie zastępuje dedykowanego zewnętrznego walidatora PDF/A. Pakuje wbudowaną diagnostykę pierwszej linii PDF/A i PDF/UA-1 biblioteki w stabilny raport dla aplikacji. Gdy aplikacja potrzebuje wyjścia tekstowego, JSON, HTML lub CSV, użyj CreatePreflightReportEx; gdy potrzebuje osobnych uchwytów list problemów zamiast sformatowanego tekstu, użyj bezpośrednio CheckFileCompliance.

Raport tekstowy jest źródłem kanonicznym każdego raportu sformatowanego. Zawiera zmienne metadane Generated:, ścieżkę Input:, wybrane kontrole, tryb zbierania problemów, po jednej sekcji dla każdego wybranego testu zgodności oraz końcowe podsumowanie z Total issues i Result.

Przepływy raportowania wiersza poleceń i wsadowego opisano w Preflight Reports.

Przykład

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

Zobacz również

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