|
Required Parameter Group:
|
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.
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 format that identifies the type of license information to be retrieved. The only format name supported is:
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.
The name of the format that describes the product identification. The only format name supported is:
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.
The name of the format containing the systems. The only format name supported is:
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
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 |
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 |
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 |
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:
Feature. The feature of the product. Valid values for the feature are 5001 through 9999. For the input parameter the valid special value is:
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:
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. For the input parameter the valid special value is:
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:
Product identifier. The product identifier of the product or feature. For the input parameter the valid special value is:
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:
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.
Vendor data. The data for this field comes from the software provider along with the license key information.
|
Top
| Software Product APIs
Software Product API list | APIs by category |
| [Information Center Home Page | Feedback ] | [Legal | AS/400 Glossary] |