Input argument check script

Usage

An input argument check script belongs to a command input argument and checks if the value of the input argument is valid, before executing the command.

[Note]Note
To check several, mutually dependant input arguments, instead of the value of a single input argument, the command in_check script should be used instead of the command input argument check script. See the section called “Command in_check script” for checking several mutually dependant input arguments.

Selector syntax

Table 7.11. Input argument check script selector

ProductionSyntaxLinks
input_argument_check_script_selectorcommand_id "." input_argument_id "." "check"the section called “Input argument check script”

Input arguments

This script always has one input argument that holds the value to be checked. The id and type of this input argument are the same as those of the command's input argument.

Moreover, if the script belongs to an object (i.e. it is defined in a type) then a second input argument holds a reference to the object. This argument's id is i_object_, and its type is the type of the object. i_object_ is used whenever the object's state must be considered in the script. If the script belongs to a service then no such input argument exists.

Output argument

This script always has one output argument whose id is o_error and whose type is ty_error_check_input_argument. o_error is void if the input argument is valid. Otherwise it returns an error describing the first check that failed.

Examples

See:

See also