Retrieve Software Agreement (QLPRAGR) API
Required Parameter Group:
| 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(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Software Agreement (QLPRAGR) API retrieves the software agreement acceptance status of a licensed program.
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)
The format of the software agreement information being returned. The valid format name is LPAG0100. For details, see LPAG0100 Format.
- Product ID
- INPUT; CHAR(7)
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.
- Product Release
- INPUT; CHAR(6)
The version, release, and modification level of the product for which the
software agreement acceptance status is being retrieved. The Product Release
can be passed as one of the following two formats:- VxRyMz
- Where x is any numeric character 0 through 9, y is any numeric character 0 through 9, and z is any numeric character 0 through 9 or uppercase letter A through Z. For example, V7R2M0 is version 7, release 2, modification 0.
- vvrrmm
- Where vv are any numeric characters 00 through 35 representing the version
of the product, rr are any numeric characters 00 through 35 representing the
release of the product, and mm can be 00 through 09 or 0A through 0Z representing
the modification of the product. This format must be used if the version or
release of the product is greater than 9. For example, 110300 is version 11,
release 3, modification 0.
- Product Option
- INPUT; CHAR(4)
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.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Receiver Variable
The following table describes the order and format of the data that is returned in the receiver variable.
LPAG0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(1) | Acceptance status |
Field Descriptions
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).
Error Messages
| 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. |
API introduced: V5R4