GetAPIScopeReportJSON

Diagnostyka, inspekcja strumienia zawartości, edycja dokumentu

Opis

Zwraca deterministyczny raport JSON o naruszeniach zakresu interfejsu API, aktualnie aktywnych zakresach środowiska wykonawczego i opcjonalnej walidacji zawartości wybranej strony

Składnia

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

Wartości zwracane

Zwraca JSON zawierający ogólne flagi valid i balanced, wybrany dokument i stronę, currentScope, pola aktywnego kontenera i głębokości, łączną i zachowaną liczbę naruszeń, uporządkowane zdarzenia środowiska wykonawczego oraz obiekt walidacji content

Każde zdarzenie środowiska wykonawczego zawiera monotoniczną sekwencję, dokument, stronę, nazwę interfejsu API, stabilny kod, oczekiwany i rzeczywisty zakres oraz komunikat diagnostyczny

Walidacja zawartości raportuje niedopasowane lub niezamknięte sekwencje q/Q, BT/ET, oznakowanej zawartości i ścieżek wraz z pozycjami tokenów

Zwraca pusty ciąg i ustawia LastErrorCode na 117, gdy Options zawiera nieobsługiwane bity

Uwagi

Śledzenie środowiska wykonawczego ma stały narzut czasowy przy prawidłowych przejściach i zachowuje ostatnie 256 naruszeń bez przydzielania pamięci podczas zwykłych wywołań rysowania

Nieprawidłowe śledzone przejścia natychmiast zwracają zero i ustawiają LastErrorCode 117, zapobiegając cichemu utraceniu ścieżki, niedomiarowi stosu stanu grafiki, niedopasowanemu zamknięciu oznakowanej zawartości lub zmianom kontekstu przy otwartych zakresach

Wywołanie tej metody nie usuwa zachowanych naruszeń ani nie zmienia aktywnych zakresów; po wykorzystaniu raportu użyj ClearAPIScopeReport

Zobacz również

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates