View source for IFPROL (HLI function)

The conventions used on this page are described in [[HLI: Function summary#Function call notation conventions|Function call notation conventions]].

==Summary==
<dl>
<dt>Description</dt>
<dd>The IFPROL call (PLACE RECORD ON LIST) places the current record on the specified list.</dd>
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT, single cursor IFSTRT</dd>
<dt>IFCALL function number</dt>
<dd>33</dd>
</dl>

==Syntax==
<p class="syntax">IFPROL(RETCODE,LIST_NAME,CURSOR_NAME)</p>

<dl>
<dt>Compile-only form</dt>
<dd>Not available</dd>
<dt>Execute-only form</dt>
<dd>Not available</dd>
</dl>

<p>Specify the parameters in the syntax order shown above. </p>
<table>
<tr class="head">
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>RETCODE</td>
<td>[O,i,r] The Model 204 return code is the required first parameter. The code is a binary integer value.</td>
</tr>
<tr>
<td>LIST_NAME</td>
<td>[I,c,r] The list name is a required input parameter that specifies the name of the list to be used. If the list does not already exist, Model 204 creates a new list using this name. Specify a character string variable that is the name of a list, existing or new.
</td>
</tr>
<tr>
<td>CURSOR_NAME</td>
<td>[I,s,r] The name of the cursor is an input parameter that is available only for use with a multiple cursor IFSTRT thread and is required for specifying the current record to be placed on the list. Specify the cursor name as a short character string (maximum 32 characters), using the name previously assigned to the cursor in a corresponding IFOCUR call. See the description of [[IFOCUR (HLI function)#CURSOR_NAME|CURSOR_NAME for the IFOCUR call]].
<p class="note"><b>Note:</b> The cursor name is not a valid parameter for use with a single cursor IFSTRT thread.</p>
</td>
</tr>
</table>

==Usage notes==
<p>
Use the IFPROL call to add a record to a list if the record is not already on the list. You may use IFPROL to add records from a sorted set to a list.</p>
<p>
The IFPROL call is valid on all types of IFSTRT threads. On a multiple cursor IFSTRT thread, you must specify the cursor whose current record is to be placed on the list. On a single cursor IFSTRT thread, IFPROL places the current record on the list. </p>

===Coding example (COBOL)===
<p class="code">WORKING-STORAGE SECTION.
01  ARGS-FOR-CALL. 
    05 RETCODE    PIC 9(5) COMP SYNC.
    05 LISTNAME   PIC X(11) VALUE "NEWEMPLOYS;".
.
.
.
PROCEDURE DIVISION.
.
.
.
  CALL "IFPROL" USING RETCODE, LISTNAME.</p>
<p>
In this example, processing is done on a single cursor IFSTRT thread, and the IFPROL call is preceded by IFFIND and IFGET calls (not shown). </p>

[[Category: HLI functions]]