GetAPIScopeReportJSON

Diagnóstico, inspección de flujos de contenido, edición de documentos

Descripción

Devuelve un informe JSON determinista de infracciones del ámbito de la API, ámbitos de ejecución activos y validación opcional del contenido de la página seleccionada

Sintaxis

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

Parámetros

Valores devueltos

Devuelve JSON con valid, balanced, documento y página, currentScope, contenedor, profundidades, recuentos, eventos y objeto de validación content

Cada evento de tiempo de ejecución incluye una secuencia monotónica, documento, página, nombre de API, código estable, ámbitos esperado y real, y un mensaje de diagnóstico

La validación de contenido informa de secuencias q/Q, BT/ET, de contenido marcado y de trazado no emparejadas o sin cerrar, con las posiciones de los tokens

Devuelve una cadena vacía y establece LastErrorCode en 117 cuando Options contiene bits no admitidos

Observaciones

El seguimiento en ejecución tiene coste constante en transiciones correctas y conserva las últimas 256 infracciones sin asignar memoria en llamadas de dibujo ordinarias

Las transiciones no válidas devuelven cero y fijan LastErrorCode 117, evitando pérdida de rutas, desbordamientos, cierres discordantes o cambios con ámbitos abiertos

Llamar a este método no borra infracciones ni modifica ámbitos activos; utilice ClearAPIScopeReport tras consumir un informe

Véase también

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates