14.1.2 csciw:list-contains
構文
csciw:list-contains('processDataKey', procesDataValue)
機能
プロセスデータキー名とプロセスデータ値を指定し,プロセスデータキー名が示すリスト型プロセスデータにプロセスデータ値が含まれるかを判定します。
引数
csciw:list-containsの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
I/O |
説明 |
---|---|---|---|---|
1 |
processDataKey |
プロセスデータキー名 |
in |
リスト型プロセスデータの全要素を示すプロセスデータキー名を文字列型(''囲み)で指定します。プロセスデータキー名には"$"と型を示す種別を付けた変数名を指定してください。 空文字列は指定できません。 |
2 |
procesDataValue |
プロセスデータ値 |
in |
プロセスデータ値を文字列型(''囲み)または数値型で指定します。 空文字列は指定できません。 |
戻り値
リスト型プロセスデータにプロセスデータ値が含まれるかをboolean型で返します。プロセスデータ値が含まれる場合はtrueを返し,含まれない場合はfalseを返します。
指定されたプロセスデータキー名のリスト型プロセスデータが1つも存在しない場合はfalseを返します。
注意事項
-
指定されたプロセスデータキー名の書式が次のような場合は,例外が発生します。
-
プロセスデータキー名の命名規則に従っていない
-
プロセスデータキー名の末尾が"{}"ではない
-
-
プロセスデータ値に空文字列を指定した場合は,例外が発生します。
-
指定されたプロセスデータキー名とプロセスデータ値の型が一致しない場合は,型を一致させてからリスト型プロセスデータにプロセスデータ値が含まれるかを判定します。例えば,引数に次の値を指定した場合は,リスト型プロセスデータにプロセスデータ値"1"(数値型) が含まれるとき,trueを返します。
-
プロセスデータキー名:"$NKey{}"(数値型のプロセスデータキー名)
-
プロセスデータ値:"1"(文字列型のプロセスデータ値)
プロセスデータキー名とプロセスデータ値の型が一致しない場合,例外は発生しません。例えば,引数に次の値を指定した場合は,数値型のリスト型プロセスデータにプロセスデータ値"ABC"(文字列型)は存在しないため,falseを返します。
-
プロセスデータキー名:"$NKey{}"(数値型のプロセスデータキー名)
-
プロセスデータ値:"ABC"(文字列型のプロセスデータ値)
-
-
指定したプロセスデータ値が数値型の場合の注意事項を次に示します。
-
プロセスデータ値がint値の範囲外の場合,int値に丸めた値になります。
-
プロセスデータ値が小数点以下を含む値の場合,小数点以下を切り捨てます。
-