PointList
(VTScada-Layer function. Must be called with a leading backslash.)
Description: | Returns an array of tag names within the current scope, given the name of a tag type or group. NOTE: GetTagList should be used in place of PointList for all new code. |
Returns: | Array |
Usage: | Script Only. |
Function Groups: | Basic Module |
Related to: | GetTagList | ListVars |
Format: | \PointList(TagType[, SearchString, NoFilterSimulation]) |
Parameters: |
TagType |
Required. Any text expression giving a type of tag or the name of a tag group. |
SearchString |
An optional text expression. The search will be limited to tags with matching names. May include wildcards. The default is "*" (any name). |
NoFilterSimulation |
Obsolete. |
Comments: | This utility function reduces the effort required to obtain a list of tags of a particular type or group membership. If no matching tags are found, the first element of the array will be Invalid. |
Examples:
{ Get a list of the Stations } Stations = \PointList("LiftstationDrivers", "*", 0); NStations = ArraySize(Stations, 0);