Explanation of fields

Flags

Bit 0 = 0:: Use the Parameter List Interface. Process ICETOOL statements from this parameter list and return information to this parameter list. Ignore TOOLIN.
Bit 0 = 1:: Use the TOOLIN Interface. Process ICETOOL statements from TOOLIN. Ignore this parameter list.
Bits 1-31:: Reserved. Must be set to zero to ensure future extendability.

Statement Area Address and Statement Area

Each statement area address gives the location of a statement area that describes an ICETOOL operation to be performed. If the statement area address is 0, ICETOOL ignores this statement area/return area pair. Otherwise, the statement area address must point to a statement area in the following format:

A 2-byte length field containing the length of the statement area for this operation. If this field is 0, ICETOOL ignores this statement area/return area pair.
One or more 80-character ICETOOL statement images in the format described in ICETOOL statements. Each statement area must have one operator statement. Comment and blank statements before the operator statement are processed. Comment, blank, and additional operator statements after the end of the first operator statement are ignored.

Return Area Address and Return Area

Each return area address gives the location of a return area in which ICETOOL is to return operation-specific information for the operation described in the corresponding statement area. If the return area address is 0, ICETOOL does not return any information for this operation. Otherwise, the return area address must point to a return area in the following general format:

A 2-byte length field containing the length of the return area for this operation. If this field is 0, ICETOOL does not return any information for this operation.
A 1-byte operation status indicator which is set by ICETOOL as follows:
0 =

This operation was run and completed with return code 0 or 4. Operation-specific values (see the following bullet) were returned.

4 =

This operation was not run (for example, scan mode was in effect) or did not complete with return code 0 or 4. Operation-specific values (see the following bullet) were not returned.
Operation-specific values. Each count value returned by ICETOOL is an 8-byte packed decimal value with a C for a positive sign or a D for a negative sign. For a STATS operator, each minimum, maximum, average and total value returned by ICETOOL is a 16-byte packed decimal value with a C for a positive sign or a D for a negative sign. If ICETOOL set the operation status to 4, it did not return any values for this operation.

Note: Programs in LPALIB that call ICETOOL must provide return areas that ICETOOL can store into.

The required return area length and the operation-specific values returned for each operator are shown in Table 1. If the return area length is less than the length required, ICETOOL issues a message and terminates the operation.

Table 1. Return Area Lengths/Operation-Specific Values
Return Area Lengths/Operation-Specific Values Operator	Return Area Length (Bytes)	Operation-Specific Values Returned
COPY	1	None
COUNT	9	Count of records processed, or 0 if any criteria specified. If SUB(q) or ADD(r) is specified, the modified count is returned.
DATASORT	1	None
DEFAULTS	1	None
DISPLAY	9	Count of records processed
MERGE	1	None
MODE	1	None
OCCUR	17	Count of records processed, count of records resulting from criteria
RANGE	17	Count of records processed, count of values in range
RESIZE	1	None
SELECT	17	Count of records processed, count of records resulting from criteria
SORT	1	None
SPLICE	17	Count of records processed, count of records resulting from criteria
STATS	64*n+9	Count of records processed, minimum for ON field 1, maximum for ON field 1, average for ON field 1, total for ON field 1, ... minimum for ON field n, maximum for ON field n, average for ON field n, total for ON field n
SUBSET	1	None
UNIQUE	17	Count of records processed, count of unique values
VERIFY	9	Count of records processed