GetCPQuality()

Returns the Quality value of a custom property. This function is available within any Industrial Graphics client script, but may not be supported by your HMI. For more information, consult your HMI documentation.

Syntax

Int GetCPQuality(String name)

Where String name is the name of the custom property whose quality is to be retrieved.

This script function takes the name of a custom property on the graphic. This argument is of type string and it can be a reference or a constant.

If the custom property is type constant, GOOD is the quality always returned.

For use with custom properties only. It does not apply to HMI tags.

Return value

The GetCPQuality() script function returns a value 0-255 of type Integer, as per the OPC quality standard. 192 is GOOD.

Example

cp2 = GetCPQuality("cp1");

Where cp1 and cp2 are custom properties and the data type of cp2 is Integer.