Retrieve License Key Information (QLZARTVK) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name of receiver variable | Input | Char(8) |
| 4 | Product identification | Input | Char(*) |
| 5 | Product identification format name | Input | Char(8) |
| 6 | System | Input | Char(*) |
| 7 | System format name | Input | Char(8) |
| 8 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve License Key Information (QLZARTVK) API retrieves the license key information for the specified systems from the license repository. The information retrieved is about the specified product, license terms, and features. The license repository is used to store license key information. It contains a record for each license key for every unique product, license term, feature, and system. The repository may contain licenses for any system, and the product does not need to be installed.
Authorities and Locks
- API QLZARTVK Authority
- *PUBLIC(*EXCLUDE)
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 for receiver variable
- INPUT; CHAR(8)
The name of the format that identifies the type of license information to be retrieved.
The only format name supported is:
LICV0100 Basic license information is retrieved. For more information, see LICV0100 Format.
- Product identification
- INPUT; CHAR(*)
Information that uniquely identifies the product or feature whose license information is to be retrieved. The structure of this information is determined by the name of the format.
- Product identification format name
- INPUT; CHAR(8)
The name of the format that describes the product identification.
The only format name supported is:
LICT0100 See LICT0100 Format.
- System
- INPUT; CHAR(*)
This indicates the system serial number for which licenses will be retrieved. The structure of this information is determined by the name of the format.
- System format name
- INPUT; CHAR(8)
The name of the format containing the systems.
The only format name supported is:
LICS0100 The systems used as input to the API. For details, see the LICS0100 Format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
LICV0100 Format
The following table describes the format of the license key information returned in the receiver variable parameter. For a detailed description of the fields in this 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 license key records |
| 12 | C | BINARY(4) | Number of license key records in list |
| 16 | 10 | BINARY(4) | Length of license key record |
| 20 | 14 | CHAR(*) | Reserved |
| Note: The offsets of the following fields vary. These fields repeat, in the order listed, for each specified product, license term, feature, and system. | |||
| CHAR(7) | Product identifier | ||
| CHAR(6) | License term | ||
| CHAR(4) | Feature | ||
| CHAR(8) | System serial number | ||
| CHAR(4) | Processor group | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Usage limit | ||
| CHAR(7) | Expiration date | ||
| CHAR(8) | Vendor data | ||
| CHAR(18) | License key | ||
| CHAR(15) | Reserved | ||
| CHAR(*) | Reserved | ||
LICT0100 Format
The following information uniquely describes the product or feature whose license information is to be added. For a detailed description of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(7) | Product identifier |
| 7 | 7 | CHAR(6) | License term |
| 13 | D | CHAR(4) | Feature |
LICS0100 Format
The following information describes the systems for which the license information is to be retrieved. For a detailed description of the field, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | System serial number |
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.
Expiration date. The date the license will expire.
The valid values are:
| CYYMMDD | C is the century, YY is the year, MM is the
month, and DD is the day. The date must be numeric as follows:
|
| 9999999 | The license does not have an expiration date. |
Feature. The feature of the product. Valid values for the feature are 5001 through 9999.
For the input parameter the valid special value is:
| *ALL | The license key information for all the features will be retrieved. |
Length of license key record. The length of each license key record.
License key. The license key for the product, license term, feature, and system.
License term. The license term of the product.
Possible values are:
| Vx or vv | The authorized usage limit is valid for the entire version of the product or feature. |
| VxRy or vvrr | The authorized usage limit is valid only for the entire release of the product or feature. |
| VxRyMz | The authorized usage limit is valid only for the modification level of the product. |
| vvrrmm | The authorized usage limit is valid only for the modification level of the product. For input, this format must be used if you need to license the modification level of the product and the version or release of the product is greater than 9. For output, this format will be returned when the product is licensed at the modification level and the version or release of the product is greater than 9. |
| *ALL | For input only. The license key information for all license terms will be retrieved. |
Where the x and y can be a number from 0 through 9. Z can be a number 0 through 9 or a letter A through Z.
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.
Number of license key records. The number of license key records in the list.
Offset to license key records. The offset from the beginning of the receiver variable to the first license key record.
Processor group. The processor group for which this license is for. This field is left justified.
The valid values are:
| *ANY | The license key is valid for any processor group. |
Product identifier. The product identifier of the product or feature.
For the input parameter the valid special value is:
| *ALL | The license key information for all the product identifiers will be retrieved. |
Reserved. Reserved for future use. If this field is input, character fields must be set to blanks and binary fields must be set to hexadecimal zeros.
System serial number. The system serial number.
For the input parameter, the valid special values are:
| *ALL | License key information for all systems will be retrieved. |
| *LOCAL | License key information for only this local system will be retrieved. |
| *REMOTE | License key information for all systems except this local system will be retrieved. |
The special values are left justified. A value other than a special value must be right justified.
Usage limit. The usage limit for this license.
| -1 | There is no maximum number of license users for this product. |
| 0-999999 | The maximum number of license users for this product. |
Vendor data. The data for this field comes from the software provider along with the license key information.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9E15 E | Error in license management function. |
| CPF9E54 E | License term &1 not valid. |
| CPF9E58 E | License key information not found. |
| CPF9E6D E | Feature &3 not valid. |
| CPF9822 E | Not authorized to file &1 in library &2. |
| CPF9826 E | Cannot allocate file &2. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R1