GetAPIScopeReportJSON

Diagnostik, inspektion af indholdsstrømme, dokumentredigering

Beskrivelse

Returnerer en deterministisk JSON-rapport om overtrædelser af API-områder, de aktuelt aktive kørselsområder og valgfri validering af indhold på den valgte side

Syntaks

Delphi

Function TPDFlib.GetAPIScopeReportJSON(
  Options: Integer= PDF_API_SCOPE_INCLUDE_CONTENT): WideString;

ActiveX

Function PDFlib::GetAPIScopeReportJSON(Options As Long) As String

DLL

const wchar_t* DLGetAPIScopeReportJSON(int InstanceID, int Options);
const char* DLGetAPIScopeReportJSONA(int InstanceID, int Options);

Parametre

OptionsNul rapporterer kørselstilstand og bevarede overtrædelser; PDF_API_SCOPE_INCLUDE_CONTENT fortolker også alle indholdslag på den valgte side

Returværdier

Returnerer JSON med de overordnede flag valid og balanced, det valgte dokument og den valgte side, currentScope, aktive felter for beholder og dybde, samlet og bevaret antal overtrædelser, sorterede kørselsbegivenheder og et content-valideringsobjekt

Hver kørselshændelse omfatter en monoton sekvens, dokument, side, API-navn, stabil kode, forventede og faktiske områder samt en diagnosticeringsmeddelelse

Indholdsvalidering rapporterer umatchede eller ulukkede q/Q-, BT/ET-, markeret-indhold- og stisekvenser med tokenpositioner

Returnerer en tom streng og angiver LastErrorCode til 117, når Options indeholder ikke-understøttede bit

Bemærkninger

Kørselstidssporing har konstant tidsforbrug ved vellykkede overgange og bevarer de seneste 256 overtrædelser uden at allokere ved almindelige tegnekald

Ugyldige sporede overgange returnerer straks nul og indstiller LastErrorCode 117, hvilket forhindrer lydløst tab af stier, underløb i grafiktilstanden, uoverensstemmende lukning af markeret indhold eller kontekstændringer med åbne områder

Et kald af denne metode rydder ikke bevarede overtrædelser og ændrer ikke aktive områder; brug ClearAPIScopeReport, når en rapport er behandlet

Se også

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates