IFRPRM (HLI function)
The conventions used on this page are described in Function call notation conventions.
Summary
- Description
- The IFRPRM call (RESET PARAMETER) resets the value of one or more specified Model 204 parameters.
- Thread type
- multiple cursor IFSTRT, single cursor IFSTRT
- IFCALL function number
- 27
Syntax
IFRPRM(RETCODE,PARM_LIST,FILE_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. |
| PARM_LIST | [I,c,r] The parameter list is a required input parameter that specifies the name and value pair for each Model 204 parameter whose value is to be reset. Specify a character string using the following format:
parm1=value1 [,parm2=value2 ...]; where: parm1 is the name of the Model 204 parameter to be reset, and parm2 is the name of a second parameter to be reset. Additional parameters may be specified in a name-value pair. Specify the keyword name of the Model 204 system, file, or user parameter. value1 is the new value for the specified parameter in the first pair, and value2 is the new value for the specified parameter in the second pair. A value is required for each name that is specified in the list. Values can be specified in decimal form, such as 193, in hexadecimal form, such as X'C1', or in character form, such as C'A'. For example, the specification OPENCTL=128 is equivalent to OPENCTL=X'80'. You can specify more than one name=value pair, separating each by a comma or a blank. |
| FILE_SPEC | [I,s,o] The file specification is an optional input parameter for use only with a multiple cursor IFSTRT thread for specifying the name of the file for which the Model 204 file parameter will be reset. Specify the Model 204 file name as a short character string using the following format:
IN [FILE] filename; The specified file must be open on the thread; otherwise, the call is unsuccessful and Model 204 returns a completion code equal to 4. |
Usage notes
Use the IFRPRM call to reset certain Model 204 system, file, or user parameters. The IFRPRM call is valid for resetting individual file parameters only in file context, not for a group. IFRPRM follows the same basic rules for specifying parameter settings as the Model 204 RESET command.
The IFRPRM call is equivalent to the IFSPRM call.
The IFRPRM call is valid on all types of IFSTRT threads. Note that the file context can change on a multiple cursor thread. If a Model 204 file parameter is specified for PARM_LIST and the file specification parameter (FILE_SPEC) is omitted, IFRPRM resets the value for the default file on the thread.
Note: Use IFRPRM with caution to avoid resetting sensitive parameters that may affect the entire operating environment. For information about Model 204 parameters, see List of Model 204 parameters.
Resetting TBO or non-TBO files
If a file is the only file open for all threads on a job, you may reset the file parameters to change the file from transaction backout (TBO) to non-TBO or vice versa. Note, however, that changing a file from TBO to non-TBO (or non-TBO to TBO) will cause a file discontinuity for backout and recovery.
Therefore, if you use the IFRPRM call to change TBO status, Rocket suggests that you reset the TBO parameters as soon as possible as described in the steps below. In this example, the job starts with TBO files in use.
- Before you start, commit all current updates and close all open files
- Open just the file you want to change, reset that file from TBO to non-TBO, and close the file.
- Open the non-TBO files that you need, and perform whatever work needs to be done with the file set as non-TBO. When you are done, commit the updates and close all files.
- As soon as possible, reopen the file that you originally changed, set it back to TBO, and close the file.
- At this point, you can reopen files and continue working.
Coding example (COBOL)
WORKING-STORAGE SECTION. 01 CALL-ARGS. 05 RETCODE PIC 9(5) COMP SYNC. 05 RESET PIC X(12) VALUE 'OPENCTL=128;'. . . . PROCEDURE DIVISION. . . . CALL "IFRPRM" USING RETCODE, RESET.