GetAPIScopeReportJSON

Diagnostika, kontrola toků obsahu, úpravy dokumentů

Popis

Vrací deterministickou JSON zprávu o porušeních rozsahů API, aktuálně aktivních runtime rozsazích a volitelné validaci obsahu vybrané stránky

Syntaxe

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

Parametry

Návratové hodnoty

Vrací JSON obsahující celkové příznaky valid a balanced, vybraný dokument a stránku, currentScope, pole aktivního kontejneru a hloubky, celkové a uchované počty porušení, seřazené události běhu a objekt validace content

Každá událost běhu obsahuje monotónní sekvenci, dokument, stránku, název API, stabilní kód, očekávané a skutečné rozsahy a diagnostickou zprávu

Validace obsahu hlásí nespárované nebo neuzavřené sekvence q/Q, BT/ET, marked-content a cesty s pozicemi tokenů

Vrací prázdný řetězec a nastaví LastErrorCode na 117, když Options obsahuje nepodporované bity

Poznámky

Sledování běhu má režii konstantního času na úspěšných přechodech a uchovává posledních 256 porušení, aniž by alokovalo při běžných kreslicích voláních

Neplatné sledované přechody okamžitě vrátí nulu a nastaví LastErrorCode 117, čímž brání tichému ztracení cesty, podtečení grafického stavu, neshodnému uzavření marked-content nebo změnám kontextu s otevřenými rozsahy

Volání této metody nemaže uchované porušení ani nemění aktivní rozsahy; po zpracování zprávy použijte ClearAPIScopeReport

Viz také

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates