CBL_CTF_TRACER_GET

コンポーネントを識別するために他のトレース ルーチンに渡すことができるトレーサー ハンドルを返します。

構文:

call "CBL_CTF_TRACER_GET" using by value     flags
                                by reference component-name
                                by reference tracer-handle
                                   returning status-code

パラメーター:

  呼び出しプロトタイプ使用時 (「説明の読み方」を参照) PIC
flags cblt-x4-comp5 pic x(4) comp-5
component-name pic x(n) pic x(n)
tracer-handle cblt-x4-comp5 pic x(4) comp-5
status-code 説明の読み方」を参照  

入力パラメーター:

flags
制御フラグ:
ビット 0 から 29
将来使用するために予約されています。値は常に 0 です。
ビット 30
意味
0 component-name は空白文字で終了します。
1 component-name は null で終了します。ビット 31 を設定していない場合は無視されます。
ビット 31
将来使用するために予約されています。値は常に 0 です。
component-name
空白文字または null (ビット 30 の設定で決まる) で終了するコンポーネント識別子文字列。大文字と小文字は区別されません。

出力パラメーター:

tracer-handle
他のトレース ルーチンに指定するトレーサー ハンドル。
status-code
次のいずれかになります。
  • 78-CTF-RET-INVALID-COMPONENT-NAME
  • 78-CTF-RET-NOT-ENOUGH-MEMORY
  • 78-CTF-RET-SUCCESS

説明:

コンポーネントでトレース操作を実行する際は、実行前にこのルーチンを呼び出してトレーサー ハンドルを取得します。このルーチンの呼び出しで取得したハンドルを CBL_CTF_COMP_PROPERTY_GET、CBL_CTF_COMP_PROPERTY_SET、CBL_CTF_LEVEL、CBL_CTF_DEST、CBL_CTF_TRACER_LEVEL_GET、CBL_CTF_TRACER_NOTIFY などのルーチンの呼び出しで使用することができます。

注: 最初にトレーサー ハンドルを取得しなくても、トレーサー ハンドルの代わりにコンポーネント識別子文字列を指定することでイベントをトレースすることもできます。ただし、コンポーネント識別子は使用するたびに検証されるため、コンポーネント識別子を指定するとパフォーマンスに影響します。そのため、このルーチンの呼び出しから返されるトレーサー ハンドルを代わりに使用することをお勧めします。

例:

「mycomp」コンポーネントのイベントをトレースするためのトレーサー ハンドルを取得します。

copy "cbltypes.cpy".
copy "mfctf.cpy".

01 component-name  pic x(7) value “mycomp”.
01 tracer-handle   pic x(4) comp-5.
...
call "CBL_CTF_TRACER_GET" using by value 0
                                by reference component-name
                                by reference tracer-handle
...