GetHistoricalDataFieldName

<< Click to Display Table of Contents >>

マニュアル > コントロールリファレンス > その他 > ヒストリカルデータコントロール > メソッド >

GetHistoricalDataFieldName


 

ヒストリカルデータサーバのフィールド名を取得する。

 


構文

GetHistoricalDataFieldName(

         serverType,

         filter,

         &fieldNames

         [,&comments]

         )

 


パラメータ

 

serverType


型:

文字


対象となるデータ。

"csv" - csvデータのみを対象

"odbc" - ODBCデータのみを対象

※csv/odbcどちらも指定されていない場合、両方が対象

"field_data" - データフィールドのみを対象

"field_time" - 時刻フィールドのみを対象

"field_ms" - 時刻フィールド(ms)のみを対象

※field_data/field_time/field_msのすべてが指定され

 ていない場合、すべてのフィールドが対象

また、複数のタイプを指定したい場合、"odbc field_data field_time"と列挙する。

例)""  - すべてが対象

例)"field_data"  - 値フィールドを対象

例)"csv field_data" - csv保存した値フィールドを対象

 

filter


型:

文字


アクション名、パス、コメントを指定可能。何も指定しない場合("")、すべてのデータが対象となる。%によりあいまい検索が可能。

指定する場合は、以下のキーワドを指定する。

キーワードはaction/path/commentの3つがある。

[action] -- アクション名のみフィルタ

[path] -- データソースパス名のフィルタ

[comment] -- コメントのフィルタ

 

例)[action]%RAW::%

例)[path]%RAW::%

例)[comment]%FUN%

 

※何もキーワードの指定がない場合、[action]と解釈される。

 

上の指定は以下の例のようにカンマで区切ることにより、複数の条件をAndで検索することが出来る。

 

例)

アクションがA01、パスにRAWを含み、FCUというキーワードがコメントに含まれるもの

[action]A01,[path]%RAW::%,[comment]%FCU%

 

なお、あいまい検索の設定方法は以下の様な内容となる。

例)""  - すべてが対象

例)"A01"  - A01という名前のアクションが対象

例)"ABC%"  - 先頭文字が"ABC"のアクションが対象

例)"%ABC"  -末尾文字が"ABC"のアクションが対象

例)"%ABC%"  -"ABC"文字が含まれるアクションが対象

 

fieldNames


型:

文字


取得したフィールド名が返ってくる。

 

comments


型:

文字


取得したフィールドのコメントが返ってくる。

 

戻り値



型:

ブール


FALSE - 失敗。TRUE - 成功。

 


hmtoggle_plus1 解説

 


参照