GetHistoricalDataFieldName

<< Click to Display Table of Contents >>

Manual > Control Reference > Other > Historical data control > Method >

GetHistoricalDataFieldName


 

Get the field name of Historical data server.

 


syntax

GetHistoricalDataFieldName(

         serverType,

         filter,

         &fieldNames

         [,&comments]

         )

 


Parameters

 

serverType


Type:

character


The data in question.

"csv" - For csv data only

"odbc" - for ODBC data only

*If neither csv/odbc is specified, both will be targeted.

"field_data" - for data fields only

"field_time" - for time fields only

"field_ms" - for time fields (ms) only

* All of field_data/field_time/field_ms are specified.

If not, all fields are included

If you want to specify multiple types, list them as "odbc field_data field_time".

Example: "" - applies to all

Example: "field_data" - for value fields

Example) "csv field_data" - csv Saved value field

 

filter


Type:

character


You can specify the action name, path, and comment. If you do not specify anything (""), all data will be targeted. You can use % to perform a fuzzy search.

If you want to specify it, use the following keywords:

There are three keywords: action/path/comment.

[action] -- Filter only the action name

[path] -- Data source path name filter

[comment] -- Comment filter

 

Example: [action]%RAW::%

Example: [path]%RAW::%

Example: [comment]%FUN%

 

*If no keyword is specified, it will be interpreted as [action].

 

The above specification can be used to search for multiple conditions using And by separating them with commas, as in the example below.

 

example)

Action is A01, path contains RAW, and comment contains the keyword FCU

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

 

The method for setting up a fuzzy search is as follows:

Example: "" - applies to all

Example: "A01" - Actions named A01 are targeted

Example) "ABC%" - Actions beginning with "ABC" are targeted.

Example) "%ABC" - Actions ending with "ABC" are targeted

Example) "%ABC%"  Target actions that contain -"ABC" characters

 

fieldNames


Type:

character


The name of the retrieved field is returned.

 

comments


Type:

character


The comment for the retrieved field is returned.

 

Return Value



Type:

Boolean


FALSE - Failure. TRUE - Success.

 


hmtoggle_plus1Explanation

 


reference