GetTagProperty

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

Description:	Returns a specified tag property as a pointer or value. Can return high scale value, low scale value, latitude or longitude.
Returns:	Pointer or Value (dependent on "GetPointer" parameter).
Usage:	Script or steady state.
Function Groups:	Basic Module
Related to:	GetTagTypes
Format:	\GetTagProperty(TagObject, PropertySpecifier, [GetPointer]);
Parameters:

TagObj

Required. Tag possessing desired property value.

PropertySpecifier

Required. Constant for selecting desired property.

GetPointer

Optional Boolean. Determines whether the tag property value (FALSE) or a pointer containing the value (TRUE) is returned by the function. Returns value by default.

Comments:

This function is used to retrieve specific tag values, denoted by the constants that get passed into the function as the "PropertySpecifier": Constant Value #PROP_LOW_SCALE 0 #PROP_HIGH_SCALE 1 #PROP_LATITUDE 2 #PROP_LONGITUDE 3

Example:

Get the specified value:

tagLowScaleValue = \GetTagProperty(TagObj, \#PROP_LOW_SCALE);

Get the specified value contained in a pointer:

tagLowScaleValuePtr = \GetTagProperty(TagObj, \#PROP_LOW_SCALE, TRUE);