Retrieve Cartridge Filter (QTARCTGF) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Cartridge Filter (QTARCTGF) API retrieves the currently defined cartridge filter for the system.
Authorities and Locks
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 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.
- Format name
- INPUT; CHAR(8)
Specifies the content and format of the information being returned.
The RFTR0100 format is used for the cartridge filter information. See RFTR0100 Format to view the information returned for this format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RFTR0100 Format
The following table shows the information that is returned for the RFTR0100 format. For more details about the fields in the following 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 array |
| 12 | C | BINARY(4) | Number of array entries |
| 16 | 10 | BINARY(4) | Length of array entry |
| Array(*) of CHAR(*) | Cartridge filter array | ||
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.
Cartridge filter array. An array of cartridge filters currently defined for the system. Each array entry may consist of either a specific cartridge identifier, or a generic name of a cartridge identifier. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. A generic name specifies all cartridge identifiers with names that begin with the generic prefix.
Note: The complete cartridge filter array will not be returned if the receiver variable is not large enough.
Length of array entry. The length, in bytes, of a single cartridge filter entry.
Number of array entries. The number of cartridge filter entries that were returned. A value of zero is returned if there is no cartridge filter set.
Offset to array. The offset, in bytes, to the cartridge filter array. A value of zero is returned if there is no cartridge filter set.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF6708 E | Command ended due to error. |
| CPF67C9 E | An Error occured during a cartridge filter operation. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R3
[ Back to top | Backup and Recovery APIs | APIs by category ]