Change Object Backup List (QEZCHBKL) API
| 1 | Input structure | Input | Char(*) |
| 2 | Input structure length | Input | Binary(4) |
| 3 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Change Object Backup List (QEZCHBKL) API changes the backup type for a list of objects that are specified by the user.
Authorities and Locks
- User Index Authority
- *CHANGE
- User Index Lock
- *SHRRD
Required Parameter Group
- Input structure
- INPUT; CHAR(*)
This structure includes the keys and data that are needed to make the necessary changes to the backup definitions.
- Input structure length
- INPUT; BINARY(4)
The length of the input structure. A minimum length of 16 is required.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format for Variable Length Records
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of variable length records |
| These fields repeat for each variable length record. | BINARY(4) | Length of variable length record | |
| BINARY(4) | Key | ||
| BINARY(4) | Length of data | ||
| CHAR(*) | Data | ||
If the length of the data is longer than the key field's data length, the data is truncated at the right. No message is issued.
If the length of the data is smaller than the key field's data length, the data is padded with blanks at the right. No message is issued.
It is not an error to specify a key more than once. If duplicate keys are specified, the last specified value for that key is used.
Each variable length record must be 4-byte aligned. If not, unpredictable results may occur.
Field Descriptions
Number of variable length records. The number of records. Only specific attributes can be changed. Refer to Valid Keys for more information.Length of variable length record. The length of each record. Only specific attributes can be changed. Refer to Valid Keys for more information.
Key. The key specifies either the library or folder attribute. For the list of valid keys, see Valid Keys.
Length of data. The length of the data that is used to specify the value for the given parameter.
Data. The data that is used to specify the value for the given key.
Valid Keys
The following table lists the valid keys for the key field area of the variable length record. For detailed descriptions of the keys, see Field Descriptions.
| Key | Type | Field |
|---|---|---|
| 1 | CHAR(*) | Library |
| 2 | CHAR(*) | Folder |
Field Descriptions
Folder. The backup type selected and the list of folder objects to have their backup type changed. For the format of this field, see Folder Key Format.
Library. The backup type selected and the list of library objects to have their backup type changed. For the format of this field, see Library Key Format.
Folder Key Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| BINARY(4) | Number in array | ||
| CHAR(1) | Backup type | ||
| Note: This field repeats for each folder name. | |||
| CHAR(12) | Folder name | ||
Field Descriptions
Folder name. The folder name of the object to be changed for the backup type that you specified.
Number in array. The number of folder names of objects to have their backup type changed. The value must be 1 or greater.
Backup type. The backup type that you selected for the folder objects. The possible values follow:
| 1 | Back up daily. Back up folder objects during the daily backup. Backing up daily means that the folder objects are also saved on the weekly and monthly backups. |
| 2 | Back up weekly. Back up folder objects during the weekly backup. Backing up weekly means that the folder objects are also saved on the monthly backups. |
| 3 | Back up monthly. Back up folder objects during the monthly backup. |
| 4 | No backup. Folder objects are not backed up at all. |
Library Key Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| BINARY(4) | Number in array | ||
| CHAR(1) | Backup type | ||
| Note: This field repeats for each library name. | |||
| CHAR(10) | Library name | ||
Field Descriptions
Library name. The library name of the object to be changed for the backup type that you specified.
Number in array. The number of library names of objects to have their backup type changed. The value must be 1 or greater.
Backup type. Backup type that you selected for the library objects. The possible values follow:
| 1 | Back up daily. Back up library objects during the daily backup. Backing up daily means that the library objects are also saved on the weekly and monthly backups. |
| 2 | Back up weekly. Backup library objects during the weekly backup. Backing up weekly means that the library objects are also saved on the monthly backups. |
| 3 | Back up monthly. Back up library objects during the monthly backup. |
| 4 | No backup. Library objects are not backed up at all. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1E65 E | Library backup list in use. |
| CPF1E6B E | Folder backup list in use. |
| CPF1EC5 E | Backup option &1 is not valid. |
| 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. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C81 E | Value for key &1 not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| 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 ]