system.secsgem.enableDisableEquipment
This function is used in Python Scripting.
Description
Enables or disables a Tuple of equipment connections from a script.
Client Permission Restrictions
Permission Type: SECS/GEM Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when called in the Gateway scope.
Syntax
system.secsgem.enableDisableEquipment(enable, names)
Parameters
| Type | Parameter | Description |
|---|---|---|
| Boolean | enable | Set to True to enable equipment connections, or set to False to disable them. |
| Tuple | names | A Tuple of Strings. Each String should match an Equipment Connection configured on the Gateway. If this parameter contains the name of an Equipment Connection that does not exist, then a message will be included in the List returned by this function. |
Returns
List - A List of unicode strings. Each string contains a message about an equipment connection that could not be enabled/disabled. If the list is empty, then all specified equipment connections were successfully modified.
Scope
Designer, Client
Code Examples
Code Snippet
# Executing this example script will attempt to disable two Equipment Connections
# Create a Python Tuple of equipment names to disable.
equipmentNames = ("ToolOne","ToolTwo")
# Invoke the Function
result = system.secsgem.enableDisableEquipment(False, equipmentNames)
# Print the results of any equipment connections that could not be modified.
print result