IFRRFL (HLI function)

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

Summary

Description

The IFRRFL call (REMOVE RECORD FROM LIST) removes the current record from the specified list.

Thread type

multiple cursor IFSTRT, single cursor IFSTRT

IFCALL function number

34

Syntax

IFRRFL(RETCODE,LIST_NAME,CURSOR_NAME)

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_NAME	[I,c,r] The list name is a required input parameter that specifies the name of the list to be used. Specify a character string variable that is the name of an existing list.
CURSOR_NAME	[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 removed. Specify the cursor name as a short character string, using the name previously assigned to the cursor in a corresponding IFOCUR call. See the description of CURSOR_NAME for the IFOCUR call. Note: The cursor name is not a valid parameter for use with a single cursor IFSTRT thread.

Usage notes

Use the IFRRFL call to remove a record from a list.

The IFRRFL call is valid on all types of IFSTRT threads. On a multiple cursor IFSTRT thread, you must specify the cursor name for the current record. On a single cursor IFSTRT thread, IFRRFL processes the current record using the set that is current for the file or group most recently opened.

Coding example (COBOL)

WORKING-STORAGE SECTION. 01 ARGS-FOR-CALL. 05 RETCODE PIC 9(5) COMP SYNC. 05 LISTNAME PIC X(5) VALUE "SAVE;". . . . PROCEDURE DIVISION. . . CALL "IFRRFL" USING RETCODE, LISTNAME.

In this example, processing is done on a single cursor IFSTRT thread, and the IFRRFL call is preceded by IFFIND, IFLIST, and IFGET calls (not shown).