GetAPIScopeReportJSON

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

Descripción

Devuelve un informe JSON determinista sobre infracciones de ámbito de API, los ámbitos de tiempo de ejecución activos actualmente 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 que contiene los indicadores generales valid y balanced, el documento y la página seleccionados, currentScope, campos de contenedor activo y profundidad, recuentos totales y retenidos de infracciones, eventos de tiempo de ejecución ordenados y un objeto de validación de 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 secuencias q/Q, BT/ET, de contenido marcado y de ruta que no coinciden o no están cerradas, con posiciones de token

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

Observaciones

El seguimiento en tiempo de ejecución tiene sobrecarga de tiempo constante en transiciones correctas y conserva las 256 infracciones más recientes sin asignar memoria durante las llamadas de dibujo habituales

Las transiciones rastreadas no válidas devuelven cero de inmediato y establecen LastErrorCode 117, lo que evita pérdida silenciosa de rutas, subdesbordamiento de estado gráfico, cierre de contenido marcado no coincidente o cambios de contexto con ámbitos abiertos

Llamar a este método no borra infracciones conservadas ni altera ámbitos activos; use ClearAPIScopeReport después de consultar un informe

Véase también

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates