The EquipSetProperty function sets the property of an item of equipment.
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
INT EquipSetProperty(STRING Name, STRING Field, STRING Value, STRING Cluster)
Name:
The name of the equipment.
field:
Only properties coming from the scheduler engine can be set:
MODE: (the current mode of the equipment)
STATE: (the current state of the equipment. The state only can be set for equipment in "Override" mode)
DRMODE: (the DR mode of the equipment)
Value:
The value to be set:
MODE: 0, automatic; 2 Manual
STATE: Any state configured in the system for this equipment, also the mode set the mode to Manual otherwise an error will be sent.
DRMODE: the current DR mode level for the equipment. The value will be a positive integer to represent the current DR level or zero if inactive.
cluster:
The name of the cluster (optional)
Return Value
Returns 0 if successful otherwise it returns an error.
Related Functions
EquipGetProperty, EquipBrowseOpen,EquipBrowseClose, EquipBrowseFirst, EquipBrowseGetField, EquipBrowseNext, EquipBrowseNumRecords, EquipBrowsePrev
See Also
Published June 2018