GetAPIScopeReportJSON

診断、コンテンツストリーム検査、ドキュメント編集

説明

API スコープ違反、現在アクティブな実行時スコープ、オプションの選択ページコンテンツ検証について、決定論的な JSON レポートを返します

構文

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

パラメータ

Optionsゼロは実行時状態と保持されている違反を報告し、PDF_API_SCOPE_INCLUDE_CONTENT は選択ページのすべてのコンテンツレイヤーも解析する

戻り値

全体の valid と balanced フラグ、選択文書とページ、currentScope、アクティブなコンテナーと深さのフィールド、違反の総数と保持数、順序付き実行時イベント、content 検証オブジェクトを含む JSON を返します

各実行時イベントには、単調増加シーケンス、文書、ページ、API 名、安定コード、期待および実際のスコープ、診断メッセージが含まれます

コンテンツ検証は、トークン位置とともに、不一致または閉じられていない q/Q、BT/ET、マーク付きコンテンツおよびパスシーケンスを報告します

LastErrorCode を 117 に設定し、サポートされないビットが Options に含まれる場合は空文字列を返す

備考

実行時追跡は成功した遷移に定数時間のオーバーヘッドしか追加せず、通常の描画呼び出しでは割り当てを行わず、最新の 256 件の違反を保持します

追跡対象外の遷移は直ちに 0 を返し、LastErrorCode 117 を設定します。これにより、パスの暗黙の消失、グラフィックス状態のアンダーフロー、マーク付きコンテンツの不一致な終了、またはスコープを開いたままのコンテキスト変更を防ぎます

このメソッドを呼び出しても、保持された違反情報は消去されず、アクティブなスコープも変更されません。レポートの使用後は ClearAPIScopeReport を使用します

関連項目

ClearAPIScopeReport、GetAPIScopeReportJSONA、TraceGraphicsStates