Each ProcScript function description includes the following sections:
- Syntax—syntax of the function and how to use it in an expression.
-
Arguments—descriptions of parameters, if any.
Note: Arguments can be expressions that evaluate to the expected value, thus an argument may be provided as a literal value, or as field, variable, function, or parameter.
- Return value—values that the function returns, including values returned in $status and $procerror. If you are uncertain about the validity of the return value of a particular function, check the current value of $procerror.
- Use—limitations placed on the use of a
function, either in particular triggers or component types. All functions are allowed in the apStart trigger of the application shell, unless otherwise
stated.
In service and report components, functions that can reference global objects are not allowed if the component Self-Contained property is True. References to global and general variables (for example, as an argument or in an expression) are not allowed.
- Description and Examples—provide more details about the function and its use.
