GetPropertyAttributes Method

Fetches a list of property attributes. For a tag reference, these are properties such as new alarm status and property range information (EGU limits, list of strings alarm strings (HIHI, LOLO, etc)). Each property queried may have a different set of attributes.

Syntax

object.GetPropertyAttributes bstrFullyQualifiedName, spAttribute, vtResults, vtAttributeNames, iStatus

Properties

The GetPropertyAttributes method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

bstrFullyQualifiedName

String. The fully specified object reference. For example, (FIX32.SCADA1.AI1.F_CV).

spAttribute

Integer Enumeration. The attribute of the property that you are interested in.
 

Valid entries:
0 - CurrentValue
1 - Description
2 - Range
3 - LowEGU
4 - HighEGU
5 - CurrentAlarm
6 - AlarmAcknowledge
7 - AlarmLatched

tResults

Variant array. Returns property attribute information. All attribute information except for the range request performs a database read to fetch the information from the process database. For the range attribute, the results vary depending on the qualified name passed. If the qualified name ends in A_LAALM or A_CUALM then the results property would return a variant array of strings with the possible alarm strings (“HI”, “HIHI”, “LO”, “LOLO”, etc.). For the all other field names (F_CV, A_DESC, etc.) a range request will return the low and high EGU limits of the block that the field specifies.

tAttributesNames

Variant array of strings. This is a return value that is used to help map one fully qualified name to another. For example, if Fix32.SCADA1.AI1.F_CV is entered, and the script needs to also fetch the current alarm status for this tag, calling GetPropertyAttributes with an attribute type of CurrentAlarm returns the fully qualified name Fix32.SCADA1.AI1.A_CUALM. This can then be fetched in conjunction with the first item parsing the string, since different OPC servers may map alarm status into different fields.

iStatus

Long. Returns the error status value.

 

Return values are:
0 – OK
1 – Syntax error
2 – Data Undefined
3 – Data type mismatch

 

Example

Applies To