|
フィルタ条件で検索された構造化タグ名を取得する。
構文
FilterStructureTagName(
count,
&name
[,compareName]
[,compareClass]
[,compareMember]
[,compareFilter]
)
パラメータ
count
|
|
型:
|
Numeric
|
|
最大取得件数。-1の時制限無し。
|
&name
|
|
型:
|
String
|
|
タグ名を受け取る。
|
compareName
|
|
型:
|
String
|
|
タグ名に対するフィルタ条件。
|
compareClass
|
|
型:
|
String
|
|
クラス名に対するフィルタ条件。
|
compareMember
|
|
型:
|
String
|
|
メンバ名に対するフィルタ条件。指定したメンバ名が存在するものだけを列挙する。
|
compareFilter
|
|
型:
|
String
|
|
メンバの値条件。例えば、Value>10 など。
|
戻り値
|
|
型:
|
Boolean
|
|
FALSE - 失敗。TRUE - 成功。
|
サーバに登録されている構造化タグ名をフィルタ条件で絞込み、タグ名を列挙します。本メソッドを呼び出す毎にフィルタ条件により検索を行います。
一方、検索した結果に対し、繰り返し高速にタグの情報を取得したい場合は、GetSnapshotStructureTagValueを推奨します。
CompareName/ CompareClass/ CompareMemberは、「%」キーワードを用い、あいまい検索ができます。
|
頭が「T」となるタグ名を列挙する
|
::FilterStructureTagName(1000, vName, "T%");
|
|
「ABC」という文字を含むタグ名を列挙する
|
::FilterStructureTagName(1000, vName, "%ABC%");
|
|
compareFilterには値の条件を式で記述できます。
メンバ(Value)の値が50以上100未満のタグ名を列挙する
|
::FilterStructureTagName(1000, vName, "", "", "", "Value < 100 && Value >= 50");
|
|
サポート対象
|
スクリプトVer2(SC2)アクションで構造化タグ関連のメソッドを使用する場合は、new演算子でStructureTagオブジェクトのインスタンスを生成してください。
例)
var obj = new StructureTag;
obj.GetStructureTagValue( ・・・ );
|
参照
GetStructureMemberProperty
FilterStructureTagName
FilterStructureTagValue
CreateSnapshotStructureTag
SortSnapshotStructureTag
GetSnapshotStructureTagValue
|