CBL_CTF_COMP_PROPERTY_SET

コンポーネントのプロパティの値を指定します。
制約事項: このルーチンは現在、COBOL for JVM ではサポートされていません。

構文:

call "CBL_CTF_COMP_PROPERTY_SET" using by value     flags
                                       by reference component-id
                                       by reference property-name
                                       by reference property-value
                                          returning status-code

パラメーター:

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

入力パラメーター:

flags
制御フラグ:
ビット 0
意味
0 文字列値を指定します。ビット 1 を使用して、文字列の終了文字を決定します。
1 整数値を指定します。ビット 1 は無視してください。
ビット 1
意味
0 文字列値は空白文字で終了します。
1 文字列値は null で終了します。
ビット 2 から 28
将来使用するために予約されています。値は常に 0 です。
ビット 29
意味
0 property-name は空白文字で終了します。
1 property-name は null で終了します。
ビット 30
意味
0 component-id は空白文字で終了します。
1 component-id は null で終了します。ビット 31 を設定していない場合は無視されます。
ビット 31
意味
0 component-id は、flags のビット 31 が設定されていない場合は CBL_CTF_TRACER_GET の呼び出しから返される pic x(4) comp-5 トレーサー ハンドル、flags のビット 31 が設定されている場合は pic x(n) テキスト識別子になります。
1 component-id は、pic x(n) テキスト文字列です。文字列の終了文字はビット 30 で定義されます。
component-id
コンポーネント識別子。flags のビット 31 が設定されていない場合は pic x(4) comp-5 トレーサー ハンドル (CBL_CTF_TRACER_GET から取得)、flags のビット 31 が設定されている場合は pic x(n) テキスト識別子になります。
property-name
値を返す対象のプロパティの空白文字または null (ビット 29 の設定で決まる) で終了する名前。大文字と小文字は区別されません。
property-value
設定するプロパティ値が格納されているバッファー。文字列として指定する値については pic x(n) フィールド、整数として設定する値については pic x(4) comp-5 フィールドになります。

出力パラメーター:

status-code
次のいずれかになります。
  • 78-CTF-RET-INVALID-COMP-NAME
  • 78-CTF-RET-INVALID-TRACE-HANDLE
  • 78-CTF-RET-INVALID-PROP-NAME
  • 78-CTF-RET-NOT-ENOUGH-MEMORY
  • 78-CTF-RET-SUCCESS

説明:

CBL_CTF_COMP_PROPERTY_SET は、component-id で識別されるコンポーネントの指定したプロパティの値を設定する場合に使用します。コンポーネントに同じ名前のプロパティがすでに存在する場合は、その値が新しい値に置き換えられます。このルーチンは、構成ファイルの mftrace.comp.component-name#property エントリと同等の機能を提供します。

例:

「mycomp」コンポーネントのイベントをトレースするためのトレーサー ハンドルを取得し、「mycomp」の 2 つのプロパティの値 (null で終了する文字列値と整数値) を設定します。

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

01 component-id    pic x(7) value "mycomp ".
01 flags           pic x(4) comp-5.
01 prop-integer    pic x(4) comp-5.
01 prop-string     pic x(100).
01 tracer-handle   pic x(4) comp-5.
...
call "CBL_CTF_TRACER_GET" using by value 0
                                by reference component-id
                                by reference tracer-handle
...
compute flags = 78-CTF-FLAG-PROP-STRING-VALUE b-or
                78-CTF-FLAG-PROP-NAME-NULL-TERM
move "xxxx" & x"00" to prop-string

call "CBL_CTF_COMP_PROPERTY_SET" using by value flags
                                       by reference tracer-handle
                                       by reference "prop1 "
                                       by reference prop-string
...
compute flags = 78-CTF-FLAG-PROP-INT-VALUE
move 100 to prop-integer

call "CBL_CTF_COMP_PROPERTY_SET" using by value flags
                                       by reference tracer-handle
                                       by reference "prop2 "
                                       by reference prop-integer
...