IFPROLS (HLI function)

From m204wiki
Jump to navigation Jump to search

The conventions used on this page are described in Function call notation conventions.

Summary

Description
The IFPROLS call (PLACE RECORDS ON LIST) places a set of found records on a list. IFPROLS creates a list or references an existing list on the current thread.
Thread type
multiple cursor IFSTRT
IFCALL function number
109

Syntax

IFPROLS|IFPRLS(RETCODE,LIST_SPEC)

Compile-only form
Not available
Execute-only form
Not available

Specify the parameters in the syntax order shown above.

Parameter Description
RETCODE [O,i,r] The Model 204 return code is the required first parameter. The code is a binary integer value.
LIST_SPEC [I,c,r] The list specification is a required input parameter that specifies an existing set of found records to be added to a list. Specify the records and the list as a character string using the following format:

set qualifier ON [LIST] listname

where:

set qualifier is required; specify the setname using the IN label clause, where label is the name of a saved IFFIND, IFFNDX, IFFWOL, IFFAC, IFSORT, IFFDV, or IFSRTV compilation from a previously compiled call.

listname is required and specifies the name of a particular list. If the list does not exist, it is created.

Usage notes

Use the IFPROLS call to add records to a list.

The IFPROLS call is the equivalent of the PLACE RECORDS ON LIST statement in SOUL in the host language multiple cursor environment. For information about the PLACE RECORDS ON LIST statement, see DML statements in Parallel Query Option/204.

Coding example (COBOL)

WORKING-STORAGE SECTION. 01 CALL-ARGS. 05 RETCODE PIC 9(5) COMP SYNC. 05 LISTSPEC PIC X(20) VALUE "IN PREVFD ON LIST L;". . . . PROCEDURE DIVISION. . . . CALL "IFPROLS" USING RETCODE, LISTSPEC.