GetEquipmentLabel
(Function Library)
Description: |
Returns a defined equipment label as set in a Style tag. |
Returns: | Text |
Usage: | Script or steady state. |
Function Groups: | Function Library |
Related to: | GetEquipmentColor |
Format: | \FunctionLib.GetEquipmentLabel( IOTagObject[, StyleTagObject, Value]) |
Parameters: |
IOTagObject |
Required. An I/O tag object whose Equipment parameter contains the equipment type to examine. |
StyleTagObject |
Optional tag object. A Style tag with the desired equipment type. Defaults to the style tag used by the indicated I/O tag (which in turn defaults to System Style). |
Value |
Optional numeric. If the equipment style has a set of values, each with a different label, use this to select which should be returned. |
Comments: |
None |