GetAPIScopeReportJSON

Diagnósticos, inspeção de fluxos de conteúdo, edição de documentos

Descrição

Retorna um relatório JSON determinístico de violações de escopo da API, os escopos de runtime atualmente ativos e a validação opcional do conteúdo da página selecionada

Sintaxe

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

OptionsZero relata o estado do runtime e as violações retidas; PDF_API_SCOPE_INCLUDE_CONTENT também analisa todas as camadas de conteúdo da página selecionada

Valores retornados

Retorna um JSON com os flags gerais valid e balanced, o documento e a página selecionados, currentScope, campos de contêiner e profundidade ativos, contagens total e retida de violações, eventos de runtime ordenados e um objeto de validação content

Cada evento de runtime inclui uma sequência monotônica, documento, página, nome da API, código estável, escopos esperado e real e uma mensagem de diagnóstico

Transições rastreadas inválidas retornam zero imediatamente e definem q/QBT/ET

ClearAPIScopeReportOptions

Observações

O rastreamento de runtime tem custo de tempo constante em transições bem-sucedidas e retém as últimas 256 violações sem alocar em chamadas de desenho comuns

Transições rastreadas inválidas retornam zero imediatamente e definem LastErrorCode 117, prevenindo perda silenciosa de caminho, underflow de estado gráfico, fechamento de marked-content sem correspondência ou mudanças de contexto com escopos abertos

Chamar este método não limpa violações retidas nem altera escopos ativos; use ClearAPIScopeReport depois de consumir um relatório

Veja também

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates