| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Device | Input | Char(10) |
| 4 | Format name | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
The Retrieve Device Information (QTARDINF) API retrieves information that is associated with a specified device description.
The QTARDINF API currently supports the following device types:
Specifically, it retrieves information about the current status and mode of the specified device. The device must be varied on at run time of the API.
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.
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.
The name of the device description for which the data is to be returned.
The content and format of the information being returned. The TADS0100 format must be used for the retrieve device information. See TADS0100 Format to view the information returned for this format.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table shows the information that is returned for the TADS0100 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) | Number of active jobs |
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.
Number of active jobs. The number of active jobs for the device. For stand-alone devices the value returned will be zero or one depending on whether it is in use at the current time. Note that since stand-alone tape devices require an exclusive lock through system functions, the device will only allow one user at a time. For media library devices, multiple users can access the tape media library at the same time through shared locks; therefore, any number of jobs may be active at the same time. This field is designed to allow users to better utilize one resource tape media library such as the 3570 tape media library device.
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF6707 E | Format name &1 not valid. |
| CPF6708 E | Command ended due to error. |
| CPF6709 E | Parameter &3 not correct. |
| CPF6710 E | Specified length not correct. |
| CPF6721 E | Device &1 not a tape device. |
| CPF672F E | Resource &1 not found. |
| CPF673A E | Device &3 not varied on. |
| CPF673F E | Device &1 does not support &2. |
| CPF9814 E | Device &1 not found. |
| CPF9825 E | Not authorized to device &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Backup and Recovery APIs | APIs by category ]