CBL_CTF_EMITTER_PROPERTY_GET

エミッタの指名プロパティ値を返す。

構文:
call "CBL_CTF_EMITTER_PROPERTY_GET" using by value     flags
                                          by reference emitter-name
                                          by reference property-name
                                          by reference property-vallen
                                          by reference property-value
                                             returning status-code
パラメタ:
呼び出しプロトタイプ使用時 ( 説明の読み方) PIC (32bitシステム)
flags cblt-x4-comp5 pic x(4) comp-5
emitter-name pic x(n) pic x(n)
property-name pic x(n) pic x(n)
property-vallen cblt-x4-comp5 pic x(4) comp-5
property-value pic x(n) pic x(n)
status-code 説明の読み方 参照
入力パラメタ:
flags 制御フラグ
ビット 値 内容
0 0 文字列値を返す。ビット1で文字列終了を決定する。
1 整数値を返す。ビット1の値を無視。
1 0 スペース終了文字列の値を返す。
1 ナル終了文字列の値を返す。
2-27 今後の使用のため保留。値は0。
28 0

emitter-nameはスペース終了
1 emitter-nameはナル終了
29 0 property-nameはスペース終了
1 property-nameはナル終了
30-31 今後の使用のため保留。値は0。
emitter-name スペースもしくはナル終了（ビット28の設定による）、大文字／小文字の区別があるエミッタ名
property-name スペースもしくはナル終了（ビット29の設定による）、大文字／小文字の区別があるプロパティ名
property-vallen プロパティ値が返されるproperty-valueバッファの長さ。本ルーチンは、返された値に対して小さすぎる場合には不正となる。値が整数値で返された場合は、property-vallenは無視される。
property-value ナル文字を設定すると、ルーチンにproperty-nameに指定されたプロパティを保持するために要求されたバッファの長さを（property-vallenで）返すように指定する。
出力パラメタ:
property-vallen property-valueバッファの返された文字列の値、終了文字は含まれない。property-valueがナル文字もしくは、返される値に対して指定されたバッファ長が短すぎる場合、property-vallenは要求されたバッファ長を設定する。整数値が返された場合には、property-vallenは設定されない。
property-value プロパティ値が返されるバッファ。本バッファは文字列として返された値の pic x(n)フィールドとなるか、整数値として返された値のpic x(4) comp-5フィールドになる。
status-code 以下のいづれか1つ
  • 78-CTF-RET-BUFFER-TOO-SMALL
  • 78-CTF-RET-EMITTER-NOT-FOUND
  • 78-CTF-RET-NOT-ENOUGH-MEMORY
  • 78-CTF-RET-PROPERTY-NOT-FOUND
  • 78-CTF-RET-SUCCESS
  • 78-CTF-RET-VALUE-NOT-INTEGER
例:

"myemitter"エミッタに関連付けられた2つのプロパティ値を取得する。1つはナル終了文字列、もう1つは整数値。

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

01 emitter-name    pic x(10) value "myemitter".
01 flags           pic x(4) comp-5.
01 prop-integer    pic x(4) comp-5.
01 prop-len        pic x(4) comp-5.
01 prop-string     pic x(100).
...
compute flags = 78-CTF-FLAG-PROP-STRING-VALUE b-or
                78-CTF-FLAG-PROP-NULL-TERM
move length of prop-string to prop-len

call "CBL_CTF_EMITTER_PROPERTY_GET" using
                                    by value flags
                                    by reference emitter-name
                                    by reference "prop1 "
                                    by reference prop-len
                                    by reference prop-string
...
compute flags = 78-CTF-FLAG-PROP-INT-VALUE

call "CBL_CTF_EMITTER_PROPERTY_GET" using
                                    by value flags
                                    by reference emitter-name
                                    by reference "prop2 "
                                    by value 0
                                    by reference prop-integer
...

関連項目