|
フィルタ条件で検索された構造化タグ名を取得する。
構文
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");
|
|
サポート対象
参照
GetStructureTagValue
GetStructureMemberProperty
FilterStructureTagValue
CreateSnapshotStructureTag
SortSnapshotStructureTag
GetSnapshotStructureTagValue
|