UEArea_x

The
UEArea_x
 item returns the area model of the
x
th
unacknowledged prompt in the unacknowledged prompts list.
This table shows the input and output formats for this item.
Input Format
Request:
UEArea_
<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 UEArea_x item requires the
batchsvr.ini
 file to contain this setting in the [CLIENT MGR DDE] section:
MaxPromptTableLength = n
where
n
 is the maximum number of unacknowledged prompts accessible to this item (the maximum number of entries in the array). And, where 0
£
x
£
MaxPromptTableLength
. If the number of unacknowledged prompts in the unacknowledged prompts list is larger than
n
, then this item will only access the first
n
 unacknowledged prompts in a non-sorted unacknowledged prompts list. When an unacknowledged prompt with an index of less than
n
 is removed from the unacknowledged prompts list, all subsequent unacknowledged prompts will have their index decreased by one. The default value of
MaxPromptTableLength
 is
0
 (zero).
Output Format
The UEArea_x item returns in this format:
<AreaName>
where:
Field Name
Format
Description
<AreaName>
ASCII - String
The batch’s area model name issuing the unacknowledged prompt.
This table is an example of an unacknowledged prompts list containing two unacknowledged prompts:
Time
Batch ID
Desc
Value
Area
Unit
Phase
2/24/2022 2:33:45 PM
BATCH_99
Charge_ Amount
35
AREA1
UA_1
P1
2/24/2022 2:34:06 PM
BATCH_100
Hold_Time
5
AREA1
UA_2
P44
This table shows an example of the return on this request.
TIP:
For the area associated with the prompt in the second row of the unacknowledged prompts list, request on
object
.
GetItem(UEArea_2)
returns:
AREA1
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal