Open List of Objects to be Backed Up (QEZOLBKL) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | List information | Output | Char(80) |
| 4 | Number of records to return | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Object type | Input | Char(10) |
| 7 | Type of backup to select | Input | Char(10) |
| 8 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Open List of Objects to be Backed Up (QEZOLBKL) API retrieves an open list of the objects that are to be backed up.
For more information, see Process Open List APIs.
Authorities and Locks
- User Index Authority
- *USE
- User Index Lock
- *SHRRD
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 receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable.
- List information
- OUTPUT; CHAR(80)
Information about the list that is created by this program. For a description of the layout of this parameter, see Format of List Information.
- Number of records to return
- INPUT; BINARY(4)
The number of records in the list to put into the receiver variable. The value must be 0 or greater.
- Format name
- INPUT; CHAR(8)
The name of the format to be used to return the requested information. One of the following format names may be used:
OBKL0100 Library basic information format. The object type parameter must be *LIB. For more information, see OBKL0100 Format. OBKL0200 Folder basic information format. The object type parameter must be *FLR. For more information, see OBKL0200 Format. OBKL0600 Complete information format. The object type parameter may be *FLR or *LIB. For more information, see OBKL0600 Format.
- Object type
- INPUT; CHAR(10)
The type of the objects to be returned in the list. One of the following object types may be used:
*FLR The folder information is returned. The format name may be OBKL0200 or OBKL0600. *LIB The library information is returned. The format name may be OBKL0100 or OBKL0600.
- Type of backup to select
- INPUT; CHAR(10)
The backup type of the objects that you request. Allowable backup types follow:
*DAILY Return information for objects that are backed up *DAILY. *WEEKLY Return information for objects that are backed up *WEEKLY. *MONTHLY Return information for objects that are backed up *MONTHLY. *ALL Return information for objects that are backed up *DAILY, *WEEKLY, or *MONTHLY.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Receiver Variable
The following tables describe the order and format of the data that is returned in the receiver variable.
OBKL0100 Format
The OBKL0100 format includes the basic information for a library object entry. The following table shows how this information is organized. For detailed descriptions of the fields in the list, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Backup option |
| 10 | A | CHAR(10) | Library name |
| 20 | 14 | CHAR(2) | Reserved |
OBKL0200 Format
The OBKL0200 format includes the basic information for a folder object entry. The following table shows how this information is organized. For detailed descriptions of the fields in the list, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Backup option |
| 10 | A | CHAR(12) | Folder name |
OBKL0600 Format
The OBKL0600 format includes the complete information for a library or folder object entry. The following table shows how this information is organized. For detailed descriptions of the fields in the list, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format OBKL0100 or OBKL0200 | |
| 22 | 16 | CHAR(7) | Last backup date |
| 29 | 1D | CHAR(6) | Last backup time |
| 35 | 23 | CHAR(50) | Object description text |
| 85 | 55 | CHAR(1) | Changed since last backup |
| 86 | 56 | CHAR(21) | Reserved |
Field Descriptions
Backup option. The backup option defined for the object. The possible values follow:
| *DAILY | Daily backup option. |
| *WEEKLY | Weekly backup option. |
| *MONTHLY | Monthly backup option. |
Changed since last backup. Whether the object has changed since the last backup. The possible values follow:
| 0 | No change has been made since the last backup. |
| 1 | A change has been made since the last backup. |
Folder name. The folder name of the object to be backed up.
Last backup date. The date that the object was last backed up. The format of this field is in the CYYMMDD as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Last backup time. The time that the object was last backed up. The format of this field is in the HHMMSS as follows:
| HH | Hour |
| MM | Minute |
| SS | Second |
Library name. The library name of the object to be backed up.
Object description text. The text that describes the object.
Reserved. An ignored field.
Format of List Information
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Total records |
| 4 | 4 | BINARY(4) | Records returned |
| 8 | 8 | CHAR(4) | Request handle |
| 12 | C | BINARY(4) | Record length |
| 16 | 10 | CHAR(1) | Information complete indicator |
| 17 | 11 | CHAR(13) | Date and time created |
| 30 | 1E | CHAR(1) | List status indicator |
| 31 | 1F | CHAR(1) | Reserved |
| 32 | 20 | BINARY(4) | Length of information returned |
| 36 | 24 | BINARY(4) | First record in buffer |
| 40 | 28 | BINARY(4) | Authority reason code |
| 44 | 2C | CHAR(36) | Reserved |
Field Descriptions
Authority reason code. Whether all information that you requested has been supplied due to the user's authority. The list of folders or libraries may not be the complete list of objects on the system if the user does not have the required authority to list the object. A user with *SAVSYS or *ALLOBJ authority is able to get a complete list. Without this authority, the list may not be complete.
| 0000 | The list is complete. |
| 0001 | The list may be partial due to authorization. |
Date and time created. The date and time that the list was created. The 13 characters follow:
| 1 | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| 2-7 | The date, in YYMMDD (year, month, and day) format. |
| 8-13 | The time of day, in HHMMSS (hours, minutes, and seconds) format. |
First record in buffer. The number of the first record in the receiver variable.
Information complete indicator. Whether all information that was requested has been supplied.
| I | Incomplete information. An interruption causes the list to contain incomplete information about a buffer or buffers. |
| P | Partial and accurate information. Partial information is returned when the maximum space is used and not all of the buffers that were requested are read. |
| C | Complete and accurate information. All the buffers that were requested are read and returned. |
Length of information returned. The size, in bytes, of the information that is returned in the receiver variable.
List status indicator. The status of building the list.
| 0 | Building the list is pending. |
| 1 | The list is in the process of being built. |
| 2 | The list has been completely built. |
| 3 | An error occurred when the system built the list. The next call to the Get List Entries (QGYGTLE) API causes the error to be signaled to the caller of QGYGTLE. |
Record length. The length of each record of information returned. For variable length records, this value is set to 0. For variable length records, you can obtain the length of individual records from the records themselves.
Records returned. The number of records that are returned in the receiver variable. This is the smallest of the following values:
- The number of records that fit into the receiver variable.
- The number of records in the list.
- The number of records that was requested.
Request handle. The handle of the request that can be used for subsequent requests of information from the list. The handle is valid until the Close List (QGYCLST) API is called to close the list or until the job ends.
Note: This field should be treated as a hexadecimal field. It should not be converted from one CCSID to another, for example, EBCDIC to ASCII, because doing so could result in an unusable value.
Reserved. A reserved field. This field must be set to hexadecimal or binary zero.
Total records. The total number of records available in the list.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1E65 E | Library backup list in use. |
| CPF1E67 D | Backup options and library backup list damaged. |
| CPF1E6B E | Folder backup list in use. |
| CPF1E6D D | Folder backup list damaged; new one created. |
| CPF1EC5 E | Backup option &1 is not valid. |
| CPF1EE4 E | Not authorized to run backup. |
| CPF1EEA E | Not authorized to library backup list. |
| CPF1EEB E | Not authorized to folder backup list. |
| CPF1E99 E | Unexpected error occurred. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C31 E | Object type &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8148 E | Object &4 type &3 in &9 damaged. |
| CPF8A77 E | Folder &1 not found. |
| CPF8A78 E | Folder &1 in use. |
| CPF8A79 E | Folder &1 is logically damaged. |
| CPF8A80 E | Document &2 in use in folder &1. |
| CPF9012 E | Start of document interchange session not successful for &1. |
| CPF9032 E | Document interchange session not started. |
| CPF9076 E | Internal system error processing documents or folders. |
| CPF9095 E | Folder &1 is damaged. |
| CPF909A E | Document &2 in folder &1 is damaged. |
| CPF9810 E | Library &1 not found. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9999 E | Function check. &1 unmonitored by &2 at statement &5, instruction &3. |
API introduced: V3R7
[ Back to top | Backup and Recovery APIs | APIs by category ]