Retrieve Backup Detail (QEZRTBKD) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Object name | Input | Char(*) |
| 4 | Object name length | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Object type | Input | Char(10) |
| 7 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Backup Detail (QEZRTBKD) API retrieves more detailed information about the library or folder that is to be backed up.
Authorities and Locks
- Backup Object
- *USE
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. The minimum length is 8 bytes.
- Object name
- INPUT; CHAR(*)
The name of the object to retrieve backup detail information about. The length of this field is based on the Object type parameter and the Object name length parameter. Specify either a 10-character library name or specify a 12-character folder name.
- Object name length
- INPUT; BINARY(4)
The length of the name of the object about which to retrieve backup detail information. Allowable object name lengths follow:
10 The 10-character library name when the object type parameter is *LIB. 12 The 12-character folder name when the object type parameter is *FLR.
- Format name
- INPUT; CHAR(8)
The name of the format to be used to return information to caller. The following format may be used:
RBKD0100 Backup detail information. For more information, see RBKD0100 Format.
- Object type
- INPUT; CHAR(10)
The type of object for which you are requesting information. Allowable object types follow:
*FLR Folder *LIB Library
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RBKD0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes available |
| 4 | 4 | BINARY(4) | Bytes returned |
| 8 | 8 | CHAR(7) | Last saved date |
| 15 | F | CHAR(6) | Last saved time |
| 21 | 15 | CHAR(50) | Object description text |
| 71 | 47 | CHAR(1) | Changed since last backup |
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.
Changed since last backup. Whether the object changed since the last backup. Possible values follow:
| 0 | No change has been made since the last backup. |
| 1 | Change has been made since the last backup. |
Last saved date. The date that the object was last saved to media. 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 saved time. The time that the object was last saved to media. The format of this field is in the HHMMSS as follows:
| HH | Hour |
| MM | Minute |
| SS | Second |
Object description text. The text that describes the object.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1EC7 E | The length &1 is not valid when the specified type is &2. |
| 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. |
| CPF3C24 E | Length of the receiver variable 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. |
| CPF8A75 E | Not authorized to access folder &1. |
| 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. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| 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 ]