ParamExpClear

The
PARAMEXPCLEAR
 execute allows the operator to remove an override of a specified expression that was created by a prior
ParamExpOverride
 execute. When the override clears, the current expression evaluation determines the value of the parameter expression.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[ParamExpClear(
Item, UserID, ParamExpressionID
)]
where:
Item
Name of the response item, as specified by the client.
UserID
User identification entered into the event journal associated with this event.
ParamExpression-ID
Unique ID, as assigned by the system, of the parameter expression targeted by the override. The parameter expression ID is typically retrieved by a client application using the ProcedureIDData3 data item.
Action
A successful ParamExpClear execute removes an existing expression value force and cause the value of the expression to revert to the value to which the expression currently evaluates.
Return Format
The response item populates with this data:
SUCCESS: | FAIL:
<message>
where:
Field Name
Format
Description
<message>
ASCII - String
Error message appropriately formatted for operator display.
The following table shows an example of the return on this execute.
Example:
An execute string consisting of:
ParamExpClear(Item,Station2/View,27)
Could return:
SUCCESS:
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal