Retrieve Image Catalogs (QVOIRCLG) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Image catalog type | Input | Char(1) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Image Catalogs (QVOIRCLG) API retrieves the list of image catalog names based on the image catalog type parameter.
Authorities and Locks
- Image Catalog Authority
- *USE
- Image Catalog Library Authority
- *EXECUTE
- Image Catalog Lock
- None
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable provided. The length of the receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of the receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of image catalogs to retrieve. You can use one of the following format names:
RCLG0100 Catalog list information.
- Image catalog type
- INPUT; CHAR(1)
The type of image catalogs to include in the list. You can specify one of the following types:
0 Specify this value to get all types of image catalogs. 1 Specify this value to get optical type image catalogs. 2 Specify this value to get tape type image catalogs.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format RCLG0100
For detailed descriptions of the fields in this table, see Field Descriptions.| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to first image catalog in list |
| 12 | C | BINARY(4) | Number of image catalogs returned |
| 16 | 10 | BINARY(4) | Length of image catalog list entry |
| 20 | 14 | BINARY(4) | Number of image catalogs |
| 24 | 18 | CHAR(*) | Reserved |
| CHAR(*) | Image catalog list | ||
Image Catalog List Entry
For detailed descriptions of the fields in this table, see Field Descriptions.| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Image catalog name |
| 10 | A | CHAR(10) | Image catalog library name |
| 20 | 14 | CHAR(1) | Image catalog type |
| 21 | 15 | CHAR(1) | Image catalog status |
| 22 | 16 | CHAR(50) | Image catalog text |
| 72 | 48 | CHAR(10) | Virtual device name |
| 82 | 52 | BINARY(4) | Virtual device status |
| 86 | 56 | CHAR(1) | Reference image catalog indicator |
| 87 | 57 | CHAR(1) | Dependent image catalog indicator |
| 88 | 58 | CHAR(10) | Reference image catalog name |
| 98 | 62 | CHAR(10) | Reference image catalog library name |
 108 |
6D | CHAR(1) | Image catalog mode |
| 109 | 6E | CHAR(*) | Reserved |
Field Descriptions
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Dependent image catalog indicator. An indicator of whether this image catalog is a dependent image catalog. The possible values are:
| 0 | This catalog is not a dependent catalog. |
| 1 | This catalog is a dependent catalog. |
Image catalog library name. The name of the library containing the image catalog.
Image catalog list. The list of image catalogs and information.
Image catalog mode. The current mode for a loaded optical image catalog. The possible values are:
| 0 | Not ready or tape type image catalog. |
| 1 | Normal. |
| 2 | Library. |
Image catalog name. The name of the image catalog from which the information was retrieved.
Image catalog status. The current status of the image catalog. The possible values are:
| 0 | Not ready. |
| 1 | Ready. |
| 2 | Unknown. |
Image catalog text. The text associated with this image catalog.
Image catalog type. The type of this image catalog. The possible values are:
| 0 | Optical type image catalog. |
| 1 | Tape type image catalog. |
Length of image catalog list entry. The length of each image catalog entry in the list.
Number of image catalogs. The number of image catalogs on the system of the type specified.
Number of image catalogs returned. The number of image catalogs returned.
Offset to first image catalog in list. The offset to the first image catalog in the list.
Reference image catalog indicator. An indicator of whether a dependent image catalog was created, with this catalog as the reference image catalog. The possible values are:
| 0 | This catalog is not a reference catalog. |
| 1 | This catalog is a reference catalog. |
Reference image catalog library name. The library containing the image catalog that was named as the reference catalog when this catalog was created. If this image catalog is not a dependent image catalog, this field will be blank.
Reference image catalog name. The image catalog named as the reference catalog when this catalog was created. If this image catalog is not a dependent image catalog, this field will be blank.
Reserved. Space included for alignment.
Virtual device name. The name of the virtual device associated with the image catalog. A blank virtual device name indicates that the catalog is not associated with a virtual device.
Virtual device status. The current status of the virtual device. The possible values are:
| 0 | Varied off. |
| 1 | Varied on. |
| 2 | Active. |
| 3 | No virtual device. |
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9802 E | Not authorized to object &2 in &3. |
API introduced: V5R4
[ Back to top | Object APIs | APIs by category ]