BLCMDMask_x

The
BLCMDMask_x
 item returns the command mask for the
x
th
batch in the batch list. The command mask is a binary value (passed as an integer) whose bits represent the current set of valid commands this batch can receive.
This table shows the input and output formats for this item.
Input Format
Request:
BLCMDMask_
<RowNumber>
<RowNumber>
is
ASCII - Integer
An array index. When an unacknowledged prompt generates, it adds to an array. If the unacknowledged prompts list is not sorted, then
x
is the row number of the unacknowledged prompt appearing in the unacknowledged prompts list.
The BLCMDMask_x item requires the
batchsvr.ini
 file to contain this setting in the [CLIENT MGR DDE] section:
MaxBatchTableLength = n
where
n
is the maximum number of batches accessible to this Item (the maximum number of entries in the array). If the number of batches in the batch list is larger than
n
, then this item will only access the first
n
 batches in a non-sorted batch list. When a batch with an index of less than
n
 is removed from the batch list, all subsequent batches will have their index decreased by one. The default value of
MaxBatchTableLength
 is
0
 (zero).
Output Format
The BLCMDMask_x item returns in this format:
<CMDMask>
Field Name
Format
Description
<CmdMask>
ASCII – Integer
Current set of valid commands that may be sent to the batch appearing on
x
th
row of the batch list.
This table is an example of a typical batch list containing three batches with batch IDs BATCH_98, BATCH_99, and BATCH_100:
Batch ID
Recipe
Desc
Start Time
State
Mode
BATCH_98
Vanilla
Ice Cream 1
2/24/2022 1:22:02 pm
RUNNING
O_Auto
BATCH_99
Chocolate
Ice Cream 2
2/24/2022 1:24:12 pm
RUNNING
S_Auto
BATCH_100
Premium French Vanilla
Ice Cream 3
2/24/2022 1:32:30 pm
RUNNING
O_Auto
This table shows an example of the return on this request.
TIP:
A request on
object.GetItem(BLCMDMask_3)
would return the command mask of the batch in the batch list’s third row:
2087
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal