CheckFileComplianceA

Zgodność, Inspekcja dokumentu

Opis

Końcowa litera A oznacza punkt wejścia DLL ANSI (char); powierzchnia ActiveX/COM udostępnia wyłącznie postać Unicode. Zachowanie jest identyczne jak w CheckFileCompliance, a argumenty ciągów są interpretowane przy użyciu bieżącej strony kodowej SetAnsiMode

Odczytuje zewnętrzny plik PDF i weryfikuje go względem wybranego standardu zgodności ISO. Zwracana wartość to zero (plik przechodzi wybrany test bez problemów) albo niezerowy uchwyt StringListID zawierający wszystkie wykryte problemy. Każdy wpis listy składa się z krótkiego kodu, dwukropka i czytelnego komunikatu — w dokładnie takim samym formacie kodu, jakiego używa GetPDFUADiagnostics. Wynik można przejrzeć za pomocą GetStringListCount i GetStringListItem.

Test PDF/A obejmuje wszystkie sześć trybów zgodności (PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-3a, PDF/A-3b) i odczytuje wpisy XMP pdfaid:part/pdfaid:conformance, aby ustalić właściwy zestaw reguł.

Test PDF/UA-1 (dodany w v3.56.0) sprawdza zewnętrzny plik PDF względem ISO 14289-1 i generuje kody diagnostyczne z zakresu 10xxx, aby pozostawały wizualnie odrębne od kodów PDF/A 00xxx.

Składnia

Delphi

Function DLCheckFileComplianceA(InstanceID: Integer; InputFileName, Password: PAnsiChar; ComplianceTest, Options: Integer): Integer;

DLL

int DLCheckFileComplianceA(int InstanceID, const char * InputFileName, const char * Password, int ComplianceTest, int Options);

Parametry

Wartości zwracane

Kody problemów PDF/A (ComplianceTest = 1)

Kody problemów PDF/UA-1 (ComplianceTest = 2)

Uwagi

Test PDF/A jest przeznaczony do szybkiej samokontroli przed przekazaniem pliku. Wykrywa problemy na poziomie dokumentu, które bezwarunkowo dyskwalifikują plik (niewłaściwa wersja PDF, brak OutputIntent, brak drzewa struktury na poziomie A, szyfrowanie, warstwy w PDF/A-1). Nie przechodzi jednak przez każdy operator strumienia zawartości ani nie weryfikuje osadzenia czcionek bądź odwołań do przestrzeni barw dla każdego rysowanego obiektu — te kontrole wymagają dedykowanego walidatora PDF/A, takiego jak veraPDF. Użyj tej funkcji jako kontroli pierwszej linii i bramki regresji w potokach kompilacji. Użyj CreatePreflightReport lub SavePreflightReport, gdy biblioteka ma sformatować listy problemów w raport tekstowy wielokrotnego użytku. Do raportu w formacie tekstowym, JSON, HTML lub CSV użyj CreatePreflightReportEx albo SavePreflightReportEx; pełny przepływ raportowania opisano też w Preflight Reports.

Powiązany interfejs API GetPDFUADiagnostics wykonuje analogiczne kontrole PDF/UA-1 (ISO 14289-1) dla aktualnie tworzonego dokumentu w pamięci, a nie dla pliku zewnętrznego.

Podczas tworzenia wyjścia PDF/A za pomocą tej biblioteki wywołaj SetPDFAMode przed dodaniem jakiejkolwiek zawartości. Zabezpieczenie po stronie generowania wewnątrz SetPDFAMode blokuje operacje zabronione przez wybraną część standardu, dlatego tak utworzony dokument zwykle automatycznie przechodzi CheckFileCompliance.

Przykład

// Validate a delivered PDF/A file and print all issues
var
  Issues, Count, I: Integer;
begin
  Issues := PDF.CheckFileCompliance('archive.pdf', '', 1, 0);
  if Issues = 0 then
    WriteLn('archive.pdf: PDF/A conformant')
  else
  begin
    Count := PDF.GetStringListCount(Issues);
    WriteLn('archive.pdf: ', Count, ' PDF/A issue(s) detected:');
    for I := 1 to Count do
      WriteLn('  ', PDF.GetStringListItem(Issues, I));
  end;
end;

// Fast pass/fail gate in a CI pipeline — stop on the first issue
var
  Failed: Boolean;
begin
  Failed := PDF.CheckFileCompliance('build/output.pdf', '', 1, 1) <> 0;
  if Failed then
    Halt(1);
end;

Zobacz również

Preflight Reports, CreatePreflightReport, CreatePreflightReportEx, SavePreflightReport, SavePreflightReportEx, ComparePreflightReports, SetPDFAMode, GetPDFUADiagnostics, GetStringListCount, GetStringListItem, SetPDFUAMode