IFRELR (HLI function): Difference between revisions
(Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFRELR call (RELEASE RECORDS) releases a particular record set held by the current thread.</dd> <dt>Thread type</dt> <dd>multipl...") |
No edit summary |
||
| Line 1: | Line 1: | ||
The conventions used on this page are described in [[HLI: Function call list#Function call notation conventions|Function call notation conventions]]. | |||
==Summary== | ==Summary== | ||
Revision as of 22:53, 11 July 2016
The conventions used on this page are described in Function call notation conventions.
Summary
- Description
- The IFRELR call (RELEASE RECORDS) releases a particular record set held by the current thread.
- Thread type
- multiple cursor IFSTRT
- IFCALL function number
- 103
Syntax
IFRELR(RETCODE,SET_QUAL)
- 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. |
| SET_QUAL | [I,c,r] The set qualifier is required for specifying the record set or list whose records will be released. Specify the set qualifier as a character string using either one of the following formats:
[IN label | ON [LIST] listname] where: label is the name of a saved IFFIND, IFFNDX, IFFWOL, IFFAC, IFSORT, IFFDV, or IFSRTV compilation from a previously compiled call. listname specifies the name of a list that contains the found set. |
Usage notes
Use the IFRELR call to explicitly release a single found set of records.
If you issue an IFRELR call on a sorted set, Model 204 frees the records in the scratch file. If you issue an IFRELR call on a list, Model 204 performs a CLEAR LIST function. See the IFCLST (CLEAR LIST) call.
The IFRELR call is the equivalent of the RELEASE RECORDS statement in SOUL in the host language multiple cursor environment.
Coding example (COBOL)
WORKING-STORAGE SECTION. 01 CALL-ARGS. 05 RETCODE PIC 9(5) COMP SYNC. 05 REL-SPEC PIC X(10) VALUE "IN PREVFD;". . . . PROCEDURE DIVISION. . . . CALL "IFRELR" USING RETCODE, REL-SPEC.