GetAPIScopeReportJSON

Диагностика, инспекция потоков содержимого, редактирование документов

Описание

Возвращает детерминированный JSON-отчёт о нарушениях областей действия API, текущих активных областях времени выполнения и необязательной проверке содержимого выбранной страницы

Синтаксис

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

Параметры

Возвращаемые значения

Возвращает JSON с общими флагами valid и balanced, выбранным документом и страницей, currentScope, активными контейнером и глубиной, полным и удерживаемым числом нарушений, упорядоченными событиями времени выполнения и объектом валидации contentКаждое событие времени выполнения включает монотонную последовательность, документ, страницу, имя API, стабильный код, ожидаемую и фактическую области и диагностическое сообщение

Каждое событие среды выполнения включает монотонный порядковый номер, документ, страницу, имя API, стабильный код, ожидаемую и фактическую области и диагностическое сообщение

Некорректные отслеживаемые переходы немедленно возвращают ноль и устанавливают q/QBT/ET

ClearAPIScopeReportOptions

Примечания

Отслеживание среды выполнения имеет постоянные накладные расходы при успешных переходах и удерживает последние 256 нарушений, не выделяя память при обычных вызовах рисования

Недопустимые отслеживаемые переходы немедленно возвращают ноль и устанавливают LastErrorCode 117, предотвращая тихую потерю пути, опустошение графического состояния, несоответствующее закрытие marked content или смену контекста при открытых областях

Вызов этого метода не очищает удерживаемые нарушения и не меняет активные области; используйте ClearAPIScopeReport после использования отчета

См. также

ClearAPIScopeReport, GetAPIScopeReportJSONA, TraceGraphicsStates