GetAPIScopeReportJSON

Diagnostikk, inspeksjon av innholdsstrømmer, dokumentredigering

Beskrivelse

Returnerer en deterministisk JSON-rapport av API-omfangsbrudd, de for tiden aktive kjøretidsomfangene, og valgfri validering av valgt sideinnhold

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

Parametere

Returverdier

Returnerer JSON som inneholder flaggene valid og balanced samlet, det valgte dokumentet og siden, currentScope, aktive container- og dybdefelt, totalt og beholdt antall brudd, ordnede runtime-hendelser og et content-valideringsobjekt

Hver runtime-hendelse inkluderer en monoton sekvens, dokument, side, API-navn, stabil kode, forventet og faktisk omfang, og en diagnostisk melding

Innholdsvalidering rapporterer umatchede eller ulukkede q/Q-, BT/ET-, marked-content- og path-sekvenser med tokenposisjoner

Returnerer en tom streng og setter LastErrorCode til 117 når Options inneholder ustøttede biter

Merknader

Runtime-sporing har konstant-tids-overhead på vellykkede overganger og beholder de siste 256 bruddene uten å allokere på vanlige tegnekall

Ugyldige sporede overganger returnerer null umiddelbart og setter LastErrorCode 117, noe som hindrer stille tapt sti, grafikktilstand-underflyt, umatchet lukking av marked-content eller kontekstendringer med åpne omfang

Å kalle denne metoden rydder ikke beholdte brudd eller endrer aktive omfang; bruk ClearAPIScopeReport etter å ha konsumert en rapport

Se også

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates