GetArlingtonValidationCoverageJSON

Compliance, Document inspection

Description

Returns the status and coverage of the most recent ValidateArlingtonSyntax or ValidateArlingtonPipelineSyntax call on this instance

Syntax

Delphi

Function TPDFlib.GetArlingtonValidationCoverageJSON: WideString;

ActiveX

Function PDFlib::GetArlingtonValidationCoverageJSON() As String

DLL

const wchar_t* DLGetArlingtonValidationCoverageJSON(int InstanceID);
const char* DLGetArlingtonValidationCoverageJSONA(int InstanceID);

Return values

A JSON object with a status of not-checked, passed, failed, incomplete, or error

Remarks

Read this report even when the validation method returns zero: zero can mean that no issue was found or that validation could not start

The coverage distinguishes rules that executed, unsupported rules, and rules that do not apply to the document; the counts refer to distinct model-rule and document-path pairs rather than all rows in the model

Unsupported expressions produce ARLINGTON_UNSUPPORTED issues and an incomplete coverage result instead of silently implying that every rule was checked

A stopped-first-issue run records that it stopped early and does not claim complete coverage; a known failure still has a failed result

An invalid model, pipeline, or input produces an error status; also inspect LastErrorCode for the operation failure

The report is retained until the next Arlington validation call on the same instance; the getter does not rerun validation or change the selected document

The DLL wide pointer remains valid until the next wide string return on the same instance; the A variant returns UTF-8 and follows the corresponding ANSI return-buffer lifetime

Example

IssuesID := PDF.ValidateArlingtonSyntax('input.pdf', '', ModelID, 0);
CoverageJSON := PDF.GetArlingtonValidationCoverageJSON;
if IssuesID <> 0 then
  PDF.ReleaseStringList(IssuesID);