BatchSchedGetEditMask()

This method queries the permissible actions of an active batch based on its index in the BatchSched list. The Long return value is a bit mask that can be used to determine what batch actions are permitted. If the bit is set, the action is permitted. If it is clear, the action is not permitted. The Operator Action Required bit is set if the batch is waiting for some operator input (such as Answer Question). The value can be interpreted as follows:

0 = Batch start
1 = Batch hold
2 = Batch restart
3 = Batch abort
4 = Set batch mode
5 = Operator action is pending
6 = Batch can be locked
7 = Batch can be unlocked

Syntax

ReturnValue = OcxBatchVar.BatchSchedGetEditMask (Row)

Parameters

Row

Data Type: Short

Index of item to retrieve