Reads a runtime parameter of an equipment database record from the EQPARAM.RDB database file.
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
EquipGetParameter(ClusterName, EquipmentName, ParameterName)
ClusterName
The name of the cluster (optional for a single cluster system)
EquipmentName
The name of the equipment from which to get information. The name of the equipment can be prefixed by the name of the cluster that is "ClusterName.Equipment".
ParameterName
The name of the parameter for which to retrieve a value.
Return Value
The value of the specified parameter as a string. If the parameter is a tag reference, the value of the tag shall be returned.
Note: The value field of the Equipment Runtime Parameters table can work like a tag reference when the Is Tag column is set to true or default. It can contain Variable tag, or equipment and item name reference of a variable tag (using equipment.item notation) that will result in the tag value being returned by this function.
An empty string may or may not be an indication that an error has been detected. The last error should be checked in this instance to determine if an error has actually occurred.
Related Functions
EquipBrowseFirst, EquipBrowseGetField, EquipBrowseNext, EquipBrowseNumRecords, EquipBrowseOpen, EquipBrowsePrev, EquipCheckUpdate, EquipGetProperty
Published June 2018