The Request Parameter List (RPL) is a working storage area defined in an application program and is used with Com-plete file I/O functions when accessing BDAM or ISAM data sets.
A separate RPL can be defined for each file to be accessed, but only one RPL is required and can be shared by separate files, if the application program performs the necessary initialization functions. However, if more than one file is to be accessed simultaneously, separate RPL definitions must be established.
The format of the RPL is shown in the following table.
Copy code for the RPL is provided in the Com-plete source library: COBRPL45 for COBOL, and PL1RPL45 for PL/I. For reasons of compatibility, the RPL format used in previous releases of Com-plete remains available.
| Fieldname | Location | Length | Format | Contents | ||
|---|---|---|---|---|---|---|
| Dec | Hex | |||||
| RPLIDENT | 0 | 0 | Character | Identifier string '0450'. | ||
| RPLDDN | 4 | 4 | 8 | Character | DDNAME for file. | |
| RPLNOREC | 12 | C | 2 | Binary | Number of records to be processed. O is same as 1. | |
| RPLINERR | 14 | E | 2 | Binary | Record in error. Used only when processing more than one record. Contains number of record in error when I/O error occurs, relative to number requested. | |
| RPLOCNT | 16 | 10 | 2 | Binary | Number options. Indicates how many of the next two fields are to
be included in the call. 1-Include next field 2-Include next two fields |
|
| RPLACC | 18 | 12 | 3 | Character | Type access. Specifies the technique to be used for accessing a record: | |
|
||||||
| RPLOPTN | 21 | 15 | 3 | Character | Key option. Used for ISAM files only: | |
|
||||||
This document covers the following topics:
The type access field, located at relative location 18 (X'12'), indicates the processing technique to be used when accessing records from the file. The options are listed in the following table.
| Option | Explanation |
|---|---|
| SEQ | Specifies that records are to be accessed sequentially. The key option field should not be specified. For ISAM file I/O requests, the key option field is ignored. For BDAM file I/O requests, the application program is abended if the key option field is specified. |
| DIR | Specifies that records are to be accessed randomly.For ISAM file I/O requests, the number options field should be 2, and the key option field should be initialized.For BDAM file I/O requests, the number options field should be 1. If the key option is specified, the application program is abended,. This is the only allowable option if accessing BDAM files using absolute addressing (MBBCCHHR). |
| BGN | Specifies that the first record in the file is to be accessed. If more than one record is to be processed with this call, the number of records requested is processed beginning with the first record in the file. Note that the key option field, located at relative location 21 (X'15'), is used for ISAM file accesses only. If specified for a BDAM file, the application program is abended. |
The key option field is specified only when records are to be processed randomly by key. In this case, the number options field must be initialized to 2. If the key option field is not to be used, the number options field must always be initialized to 1.
The options are listed in the following table.
| Option | Explanation |
|---|---|
| KEQ | Specifies that the record in the file with a key equal to that of the key supplied is to be accessed. If the key option is not specified, this is the default. |
| KGE | Specifies that the record in the file with a key equal to or greater than that of the key supplied is to be accessed. |