| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Product ID | Input | Char(7) |
| 5 | Product release | Input | Char(6) |
| 6 | Product option | Input | Char(4) |
| 7 | Error Code | I/O | Char(*) |
The Retrieve Software Agreement (QLPRAGR) API retrieves the software agreement acceptance status of a licensed program.
None.
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 format of the software agreement information being returned. The valid format name is LPAG0100. For details, see LPAG0100 Format.
The 7-character ID of the product for which the software agreement is being retrieved. The product ID must be in the format nxxxxxx, where n is any numeric character 0 through 9, and x is any numeric character 0 through 9 or uppercase letter A through Z.
The version, release, and modification level of the product for which the software agreement acceptance status is being retrieved. The release must be in the format VxRyMz. Valid values for x and y are 0 through 9. Valid values for z are 0 through 9 or A through Z. For example, V5R3M0 is version 5, release 3, modification 0.
The option number of the product for which the software agreement acceptance status is being retrieved. Use 0000 for the base option. Valid values are 0000 through 0099, where each character is a digit.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table describes the order and format of the data that is returned in the receiver variable.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(1) | Acceptance status |
Bytes returned. The number of bytes of data returned.
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Acceptance status. Whether or not the software agreement has been accepted for this Licensed Program. The possible values are 1 (yes) or 0 (no).
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF358A E | Release not valid. |
| CPF3C21 E | Format name &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. |
| CPF3DDF E | Product option &2 not valid. |
| CPF3DEF E | Product identifier &1 not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |