GetAPIScopeReportJSON

Diagnose, Inhaltsstromprüfung, Dokumentbearbeitung

Beschreibung

Gibt einen deterministischen JSON-Bericht über API-Gültigkeitsbereichsverletzungen, die derzeit aktiven Laufzeitgültigkeitsbereiche und eine optionale Inhaltsvalidierung der ausgewählten Seite zurück

Syntax

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

Parameter

Rückgabewerte

Gibt JSON mit den Gesamtflags valid und balanced, dem ausgewählten Dokument und der Seite, currentScope, Feldern für aktiven Container und Tiefe, Gesamt- und beibehaltenen Verstoßanzahlen, geordneten Laufzeitereignissen sowie einem Validierungsobjekt content zurück

Jedes Laufzeitereignis enthält eine monotone Sequenz, Dokument, Seite, API-Namen, stabilen Code, erwartete und tatsächliche Gültigkeitsbereiche sowie eine Diagnosemeldung

Die Inhaltsvalidierung meldet nicht übereinstimmende oder nicht geschlossene Folgen von q/Q, BT/ET, markierten Inhalten und Pfaden mit Tokenpositionen

Gibt eine leere Zeichenfolge zurück und setzt LastErrorCode auf 117, wenn Options nicht unterstützte Bits enthält

Anmerkungen

Die Laufzeitverfolgung verursacht bei erfolgreichen Übergängen konstanten Zeitaufwand und behält die letzten 256 Verstöße bei, ohne bei gewöhnlichen Zeichenaufrufen Speicher zuzuweisen

Ungültige verfolgte Übergänge geben sofort null zurück und setzen LastErrorCode 117, wodurch unbemerkter Pfadverlust, Unterlauf des Grafikzustands, nicht passende Abschlüsse markierter Inhalte oder Kontextwechsel bei offenen Gültigkeitsbereichen verhindert werden

Der Aufruf dieser Methode löscht keine gespeicherten Verstöße und verändert keine aktiven Gültigkeitsbereiche; nach dem Auswerten eines Berichts ClearAPIScopeReport verwenden

Siehe auch

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates