CheckFileComplianceA

Compliance, Document inspection

Popis

Koncové A označuje vstupní bod ANSI (char) knihovny DLL; rozhraní ActiveX/COM zpřístupňuje pouze formu Unicode. Chování je shodné s CheckFileCompliance a řetězcové argumenty jsou interpretovány pomocí aktuální znakové stránky nastavené funkcí SetAnsiMode

Reads an external PDF file and validates it against a chosen ISO compliance standard. The returned value is either zero (file passes the chosen test cleanly) or a non-zero StringListID handle that lists every issue detected. Each entry in the list is a short code, a colon, and a human-readable message — exactly the same code format used by GetPDFUADiagnostics. Enumerate the result with GetStringListCount and GetStringListItem.

Test PDF/A pokrývá všech šest režimů shody (PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-3a, PDF/A-3b) a přečte položky XMP pdfaid:part/pdfaid:conformance, aby rozhodl, která sada pravidel se použije

Test PDF/UA-1 (přidaný ve v3.56.0) kontroluje externí PDF proti ISO 14289-1 a vypisuje diagnostické kódy v rozsahu 10xxx, takže zůstávají vizuálně oddělené od kódů PDF/A 00xxx

Syntaxe

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

Return values

PDF/A issue codes (ComplianceTest = 1)

PDF/UA-1 issue codes (ComplianceTest = 2)

Poznámky

The PDF/A test is intended as a fast self-check before delivery. It catches the document-level issues that disqualify a file outright (wrong PDF version, missing OutputIntent, missing structure tree at the A level, encryption, layers in PDF/A-1). It does not walk every content-stream operator nor verify font embedding or color-space references for each painted object — those validations require a dedicated PDF/A validator (such as veraPDF). Use this function as a first-line check and as a regression gate in build pipelines. Use CreatePreflightReport or SavePreflightReport when you want the library to format the issue lists into a reusable text report. Use CreatePreflightReportEx or SavePreflightReportEx for text, JSON, HTML, or CSV report output, or see Preflight Reports for the complete report workflow.

Doprovodné API GetPDFUADiagnostics provádí analogické kontroly pro PDF/UA-1 (ISO 14289-1) nad dokumentem v paměti, který se právě staví, místo nad externím souborem

Když s touto knihovnou vyrábíte výstup PDF/A, zavolejte SetPDFAMode před přidáním jakéhokoli obsahu. Guard na straně generování uvnitř SetPDFAMode zablokuje operace zakázané zvolenou částí, takže dokument postavený tímto způsobem obvykle projde CheckFileCompliance automaticky

Příklad

// 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;

Viz také

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