perform/5—perform a specified action and return a value
The perform/5 performs a specified action and returns a value.
perform/5 arguments
Argument | Mode | Type | Description |
---|---|---|---|
$OBJECT | input | OBJECT | Specifies the object handle for the event or data on which the action is to be performed |
$ACTION | input | STRING | Specifies the name of the action to be performed |
$ARGS | input | LIST_OF ANY | Specifies a list of action arguments. |
$RETCODE | output | INTEGER | The numeric return code of the specified action |
$RETTEXT | output | STRING | The text string returned by the specified action |
Use perform/5 to perform the action specified by the $ACTION argument on the event or data with the object handle specified in the $OBJECT argument and return a numeric return code in $RETCODE and a text string in $RETTEXT. Required arguments for the action must be provided in the $ARGS list.
If the action returns through action_return/2, the return exit code and text value is determined by the return code and text string values defined in the perform/5 arguments. If the action does not return through the action_return/2 primitive or if it is an external action, the values 0 and an empty string will be returned.
perform/5 example