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 (32 ビット システム)
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-idはスペース終了。
1 component-idはナル終了。ビット31が設定されていない場合は、無視される。
31 今後の使用のために予約済み。値は0であること。
component-name スペースもしくはナル終了（ビット29の設定による）、大文字小文字の区別のない一意のコンポネント文字列。
出力パラメーター：
tracer-handle 他のルーチンへ指定されるトレーサハンドル
status-code 以下のうちの1つ
  • 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 and CBL_CTF_TRACER_NOTIFY

注意：トレーサハンドルの代わりに一意のコンポネント文字列を指定することにより、 トレーサハンドルの取得を行わずにイベントをトレースすることができる。ただし、コンポネントの一意名は、使用するたびに認証を行う必要がある ので、パフォーマンスに影響を与えることになる。このため、本ルーチンへの呼び出しから返されたトレーサハンドルを使用することを推奨する。

例:

"my comp"コンポネントイベントをトレースするトレーサハンドルを取得するには：

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

01 component-name  pic x(7) value
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
...

関連項目