GetAPIScopeReportJSON

诊断、内容流检查、文档编辑

描述

返回 API 范围违规、当前活动运行时范围和可选所选页面内容验证的确定性 JSON 报告

Function TPDFlib.GetAPIScopeReportJSON(
  Options: Integer= PDF_API_SCOPE_INCLUDE_CONTENT): WideString;

Function PDFlib::GetAPIScopeReportJSON(Options As Long) As String

const wchar_t* DLGetAPIScopeReportJSON(int InstanceID, int Options);
const char* DLGetAPIScopeReportJSONA(int InstanceID, int Options);

Options	零会报告运行时状态和保留的违规；`PDF_API_SCOPE_INCLUDE_CONTENT` 还会解析所选页面的所有内容层

返回包含整体 valid 和 balanced 标志、选定文档与页面、currentScope、活动容器与深度字段、总计和保留的违规计数、有序运行时事件以及 content 验证对象的 JSON

每条运行时事件包含单调递增的序号、文档、页面、API 名称、稳定代码、预期与实际作用域以及一条诊断消息

内容验证会报告不匹配或未闭合的 q/Q、BT/ET、标记内容和路径序列及其标记位置

当 LastErrorCode 为 117，且 Options 包含不支持的位时，返回空字符串

成功转换时运行时跟踪具有常数时间开销，并保留最近的 256 个违规项，普通绘制调用不会进行分配

无效的跟踪转换会立即返回零并设置 LastErrorCode 117，以防止静默路径丢失、图形状态下溢、标记内容闭合不匹配，或在范围仍打开时发生上下文更改

调用此方法不会清除保留的违规项或改变活动作用域；使用报告后请调用 ClearAPIScopeReport