GetTagMode

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

Description:	Returns text or a structure to identify what kind of tag a given instance is.
Returns:	Text
Usage:	Script or steady state.
Function Groups:	Variable
Related to:	CheckTagGroup
Format:	\GetTagMode(TagObj[, Specifier]);
Parameters:

TagObj

Required. The tag instance being checked.

Specifier

Optional text. The name of the tag attribute to return. If this parameter is Invalid, a structure including all attributes will be returned. May be any of:

IsString

IsAnalog

IsDigital

IsDiscrete

IsInput

IsOutput

IsPump

IsDriver

EquipmentType

IsAnalytic

IsMemoryTag

IsContainer

Comments:

If a structure is returned, it will contain the following fields:

IsString - TRUE for string tags or non-string tags that are configured as text

IsAnalog - TRUE for analog tags

IsDigital - TRUE for digital tags

IsDiscrete - TRUE for digital tags or IO discrete tags

IsInput - TRUE for input tags

IsOutput - TRUE for output tags

IsPump - TRUE for pumps

IsDriver - TRUE for drivers

EquipmentType - The tag's equipment type or default type

IsAnalytics - TRUE for calculation modes

IsMemoryTag - TRUE for tags with no address, excepting 2-bit digitals.

IsContainer - TRUE for tags that are containers.

Some Boolean attributes are mutually exclusive, such as IsAnalog and IsDigital. Others such as IsAnalog and IsDiscrete, are not.