SearchTags

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

SearchTags

 

Search for tags and get tag information.

 

syntax

SearchTags(

         type,

         searchWord,

         excludedPath,

         requestProperty,

         &result

         [, maxCount=0]

         [, startIndex=0]

         [, &bOverMax]

         )

 

Parameters

 

type

Type:

character

Specify the search target. You can obtain tag information for multiple types by separating the types with commas.

"all"- Target everything

"driver"- Targets the driver tag

Target "alias"-Alias tag

 

searchWord

Type:

character

The search string.

Search Syntax

U01 (characters included) /'U01' (exact match) /U01* (forward match) /*U01 (backward match)

Example: U01*

 

excludedPath

Type:

character

Specify the path to exclude. Multiple paths can be specified as an array.

Search Syntax

Character (character included) / 'character' (exact match) / character* (forward match) / *character (backward match)

Example: U01.F01*

 

requestProperty

Type:

character

The property names to request. Multiple properties can be specified as an array.

"Name"- Tag name

"Comment"- Comment

"EU"- Engineering units

 

&result

Type:

character

The retrieved property.

 

maxCount

Type:

Number

The maximum number of tags to retrieve. Specify 0 for no limit.

 

startIndex

Type:

Number

The zero-based index at which to start fetching.

 

&bOverMax

Type:

Boolean

If there are more tags than the number specified by maxCount, the result is TRUE.

 

Return Value

Type:

Boolean

FALSE - Failure. TRUE - Success.

 

hmtoggle_plus1Explanation

Get tags that meet the conditions. The only tag that can be retrieved is the preset Static tag; Active tag cannot be retrieved.

To use this method, you must enable browsing information viewing. To enable browsing information, open the properties of "Application" from the server tree and set it from the Browsing Information tab.

"View direct tag information" - The direct tags set under "Tag-Driver" will be retrieved.

"View Alias tag information" - The Alias tag set in the "Tag" property will be retrieved.

 

Reference: About browsing information

 

 

Supported

×

Script Action

Can be used in server script Ver2 actions

○

Browser script

Can be used in browser scripts

×

Calculation Expression Syntax

Can be used in expression syntax (e.g. bind syntax)

 

reference

 

RefreshTag

GetChildTags

SearchTags