GetSessionContainers

(VTScada-Layer function. Must be called with a leading backslash.)

Description:	Returns an array of the names of tags that are "container" tags that exist at any level under the given context (parent) tag.
Returns:	Array
Usage:	Script Only.
Function Groups:	Variable
Related to:	BuffOrder
Format:	\GetSessionContainers([Context, WithLocationOnly, ExcludeContextFromList]);
Parameters:

Context

Optional. The name of the tag under which to look for containers. Defaults to VTSDB.

WithLocationOnly

Boolean. When true, only tags that have valid Latitude and Longitude parameters will be returned

ExcludeContextFromList

Boolean. When true, the returned list will not include the tag specified in Context.

Comments:

Returns Invalid if nothing is found.

Example:

  If Watch(1);
  [
    AllContainers = \GetSessionContainers();
       { AllContainers contains all in the application }
    NorthSites = \GetSessionContainers("NorthStation", TRUE, FALSE);
      { NorthSites contains all mapped sites within the parent container, NorthStation. }