GetAPIScopeReportJSON

Diagnostics, inspection des flux de contenu, modification de documents

Description

Renvoie un rapport JSON déterministe des violations de portée d'API, des portées d'exécution actuellement actives et, facultativement, de la validation du contenu de la page sélectionnée

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

Paramètres

Valeurs de retour

Renvoie un JSON contenant les indicateurs globaux valid et balanced, le document et la page sélectionnés, currentScope, les champs de conteneur actif et de profondeur, le nombre total et conservé de violations, les événements d’exécution ordonnés et un objet de validation content

Chaque événement d'exécution comprend une séquence monotone, le document, la page, le nom d'API, un code stable, les portées attendues et réelles, ainsi qu'un message de diagnostic

La validation du contenu signale les séquences q/Q, BT/ET, de contenu marqué et de chemin sans correspondance ou non fermées, avec la position des jetons

Renvoie une chaîne vide et définit LastErrorCode sur 117 lorsque Options contient des bits non pris en charge

Remarques

Le suivi d'exécution ajoute un surcoût constant aux transitions réussies et conserve les 256 dernières violations sans allocation lors des appels de dessin ordinaires

Les transitions suivies non valides renvoient immédiatement zéro et définissent LastErrorCode 117, empêchant la perte silencieuse d’un chemin, un déficit de pile d’état graphique, une fermeture incorrecte de contenu marqué ou un changement de contexte avec des portées ouvertes

Cet appel n'efface pas les violations conservées et ne modifie pas les portées actives ; utilisez ClearAPIScopeReport après avoir consommé un rapport

Voir aussi

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates