Release License (QLZARLS) API
Required Parameter Group:
| 1 | Product identification | Input | Char(*) |
| 2 | Product identification format name | Input | Char(8) |
| 3 | License user | Input | Char(*) |
| 4 | License user format name | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Release License (QLZARLS) API releases the use of a product from the assigned license user. This API works the opposite of the Request License (QLZAREQ) API. Whatever was previously requested is now released and the usage count is decremented. When using this API, specify the same parameters as on the Request License API.
Authorities and Locks
- Public API Authority
- *USE
Required Parameter Group
- Product identification
- INPUT; CHAR(*)
Information that uniquely identifies the product or feature whose licensed use is to be released. 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:
LICP0100 See LICP0100 Format.
- License user
- INPUT; CHAR(*)
The name to which use of the license product is assigned and tracked.
- License user format name
- INPUT; CHAR(8)
The name of the format that describes the license user.
The formats supported are:
LICL0100 See LICL0100 Format. LICL0200 See LICL0200 Format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
LICP0100 Format
To release the licensed use of a product or feature, you must specify the same information that was specified on the Request License (QLZAREQ) API. The following table identifies the product or feature whose licensed use is to be released. For a detailed description of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(7) | Product ID |
| 7 | 7 | CHAR(6) | Release level |
| 13 | D | CHAR(4) | Feature |
LICL0100 Format
To release the licensed use of a product or feature, you must specify the same information that was specified on the Request License (QLZAREQ) API. The following table identifies the license user whose licensed use is to be released. For a detailed description of the field in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | License user |
LICL0200 Format
To release the licensed use of a product or feature, you must specify the same information that was specified on the Request License (QLZAREQ) API. The following table identifies the license user to be released and the license user handle. For a detailed description of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to license user |
| 4 | 4 | BINARY(4) | Length of license user |
| 8 | 8 | CHAR(8) | License user handle |
| 16 | 10 | BINARY(4) | Offset to additional license user information |
| 20 | 14 | BINARY(4) | Length of additional license user information |
| 24 | 18 | BINARY(4) | Reserved |
| Note: Use the offset to license user field to determine the offset. | |||
| CHAR(*) | License user | ||
| Note: Use the offset to additional license user information field to determine the offset. | |||
| BINARY(4) | Number of uses held | ||
Field Descriptions
Feature. The feature of the product. Valid values for the feature are 5001 through 9999.
Length of additional license user information. The length of the additional license user information. Set this field to 0 if there is no additional license user information.
Length of license user. The length of the license user field. This may be a value of 1 through 80. This value may only change within the same license term if there are no current users at the time the change request is made. To conserve space, use the smallest value necessary for this length.
License user. The license user being released. For registered use, specify the nonblank name you want assigned as the license user. For concurrent use, specify *JOB. For processor use, specify *PROCESSOR.
License user handle. The value passed in by the vendor at the time of the Request License (QLZAREQ) API call. When the vendor wants to release the user, this handle must be specified on the Release License (QLZARLS) API call. This value many be any 8-character field, including blanks. If the value specified on the release call does not match the value initially specified on the request call, the license user is not released. This field is never displayed or output through any license management interfaces and is only known to the vendor application.
Number of uses held. The number of uses held by the license user that are to be released. If this field is not specified, the number of uses is assumed to be 1.
The valid values follow:
| 1-999999 | The number of uses to be released. This must be the same number of uses that were requested for the license user on the Request License (QLZAREQ) API. |
| -1 | All of the uses held by the license user are to be released. This value is to be used if the calling program does not know the number of uses that the license user currently holds. |
Offset to additional license user information. The offset from the beginning of the license user information to the additional information for the first license user. Specify 0 for this field if there is no additional information for the license user.
Offset to license user. The offset from the beginning of the license user information to the first license user.
Product ID. The product ID of the product or feature whose licensed use is to be released.
Release level. The version, release, and modification level of the product.
The Release level can be passed as one of the following 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. For example, 110300 is version 11, release 3, modification 0. This format must be used if the version or release of the product is greater than 9. |
| *ONLY | The release level is determined by searching the system for a given product. The release level is taken from the product definition. This value is not valid if more than one product definition exists for the same product ID. |
Reserved. Reserved for future use. This field must be set to hexadecimal zeros.
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. |
| CPF9E1C E | License user parameter not valid. |
| CPF9E1E E | Length of license user is not correct. |
| CPF9E1F E | Attempt made to change length of the license user, resulting code &1. |
| CPF9E11 E | License information not retrieved. |
| CPF9E12 E | License information not available. |
| CPF9E13 E | More than one release found. |
| CPF9E14 E | License user handle not correct. |
| CPF9E15 E | Error in license management function. |
| CPF9E7B E | Cannot release different number of uses than requested. |
| CPF9E91 E | License user &1 is not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPI9E75 I | Grace period will expire in &5 days on &4. |
| CPI9E76 I | Expiration date will be reached in &5 days on &4. |
| CPI9E77 I | License key will not be valid in &8 days on &9. |
API introduced: V2R3