7 98 1 USE Parameters

LANSA Technical

7.98.1 USE Parameters

BUILTIN

TO_GET

WITH_ARGS

BUILTIN

Specifies the name of the Built-In Function that is to be invoked. The name must match one of those specified in the Built-In Functions.

WITH_ARGS

Optionally allows a list of up to 20 arguments to be passed to the Built-In Function.

An entry in the list of arguments may be a field name, an expandable group expression, an alphanumeric literal, a numeric literal or a system variable name. The values of entries specified in an argument list are not changed by the Built-In Function (unless the same field name is repeated in the RET_VALS list).

Entries specified in an arguments list must match in type and number those specified for the Built-In Function. Refer to the Built-In Functions for further details.

TO_GET

Optionally allows a list of up to 20 field names to be specified as "return values" passed back by the Built-In Function.

Some Built-In Functions can return information to the program that invoked them. In such cases the return values are mapped back into fields that are nominated in the RET_VALS list.

An entry in the list of return values can only be a field name. The field must be defined in the LANSA dictionary or within the function by a DEFINE command. Expandable group expressions are allowed in this parameter.

Entries specified in a return values list must match in type and number those specified for the Built-In Function. Refer to the Built-In Functions for more details.