GetChildTags

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

GetChildTags

 

Obtain tag information for each level.

 

syntax

GetChildTags(

         type,

         tagPath,

         excludedPath,

         requestProperty,

         &result,

         &itemTypes

         [, maxCount=0]

         [, startIndex=0]

         [, &bOverMax]

         )

 

Parameters

 

type

Type:

character

Specify the object to be acquired.

"all"- Targets everything.

"driver"- Targets the driver tag.

Target "alias"-Alias tag.

 

tagPath

Type:

character

Parent tag path string

Example: U01.F01

 

excludedPath

Type:

character

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

Search Syntax

U01 (characters included) /'U01' (exact match) /U01* (forward match) /*U01 (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"- Industrial units

"ChildObjCount"- Number of child objects

 

&result

Type:

character

The retrieved property.

 

&itemTypes

Type:

Number

The type of tag retrieved.

0-Folder

1- Tag

2-member

 

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

Specify the parent tag path to get information about the child tags belonging to that parent. 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