Add Validation List Entry (QSYADVLE) API
Required Parameter Group:
| 1 | Qualified validation list name | Input | Char(20) |
| 2 | Entry ID information | Input | Char(*) |
| 3 | Data to encrypt information | Input | Char(*) |
| 4 | Entry data information | Input | Char(*) |
| 5 | Attribute information | Input | Char(*) |
| 6 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Add Validation List Entry (QSYADVLE) API adds an entry to a validation list object. Entries are stored in hexadecimal sort sequence. The first entry will always be the one in which the entry ID has the smallest hexadecimal value.
Conversions are not done on any data when entries are added. The CCSID value for each field is stored as part of the record but is not used when the entry is added to the validation list.
Authorities and Locks
- Validation List Object
- *USE and *ADD
- Validation List Object Library
- *EXECUTE
Required Parameter Group
- Qualified validation list name
- INPUT; CHAR(20)
The qualified object name of the validation list to add the entry to. The first 10 characters specify the validation list name, and the second 10 characters specify the library.
You can use these special values for the library name:
*CURLIB The current library is used to locate the validation list. If there is no current library, QGPL (general purpose library) is used. *LIBL The library list is used to locate the validation list.
- Entry ID information
- INPUT; CHAR(*)
The format of the entry ID information is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) Length of entry ID >4 4 BINARY(4) CCSID of entry ID >8 8 CHAR(*) Entry ID
- Data to encrypt information
- INPUT; CHAR(*)
Data that is associated with the entry ID and is encrypted by the system when it is stored.
The format of the data to encrypt information is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) Length of data to encrypt 4 4 BINARY(4) CCSID of data to encrypt 8 8 CHAR(*) Data to encrypt
- Entry data information
- INPUT; CHAR(*)
Data information that is associated with the entry ID. The format of the entry data information is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) Length of data 4 4 BINARY(4) CCSID of data 8 8 CHAR(*) Data
- Attribute information
- INPUT; CHAR(*)
Attribute information that is associated with the entry. The format of the attribute information is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) Number of attributes 4 4 CHAR(*) Attribute structures
The format of the attribute structure is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) Length of attribute entry 4 4 BINARY(4) Attribute location 8 8 BINARY(4) Attribute type 12 C BINARY(4) Displacement to attribute ID 16 10 BINARY(4) Length of attribute ID 20 14 BINARY(4) Displacement to attribute data 24 18 BINARY(4) Length of attribute data CHAR(*) Attribute ID CHAR(*) Attribute data
For attributes that are stored in the validation list object, the format of the attribute data is as follows. See the Field Descriptions for more information.
Offset Type Field Dec Hex 0 0 BINARY(4) CCSID of attribute 4 4 BINARY(4) Length of attribute 8 8 CHAR(8) Reserved 16 10 CHAR(*) Attribute value
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Field Descriptions
Attribute data. The information that describes the attribute data.
Attribute ID. The ID of the attribute. For system-defined attributes, the allowed values are:
| String value | Description |
|---|---|
| QsyEncryptData | This is the attribute that is associated with the data to encrypt. |
Attribute location. Where the attribute should be stored.
The allowed value is:
| 0 | The attribute is stored in the validation list object. |
Attribute structures. Zero or more attribute structures that define the attributes to be associated with the entry.
Attribute type. The type of attribute.
The allowed value follows:
| 0 | This is a system-defined attribute. |
Attribute value. The value of the attribute that is associated with the entry.
For the QsyEncryptData attribute, the allowed values follow:
| 0 | The data to be encrypted can only be used to verify an entry. This is the default. |
| 1 | The data to be encrypted can be used to verify an
entry and can be returned on a find operation. The system value QRETSVRSEC
(Retain server security data) is used to determine if the data to be encrypted
is stored in the entry or not.
If the system value is set to 0 (Do not retain data), the entry will be added, but the data to be encrypted will not be stored with the entry. The return value from this function will be -2 to indicate that the entry was added, but the data to be encrypted was not stored. If the system value is set to 1 (Retain data), then the data to be encrypted will be stored in encrypted form when the entry is added. |
CCSID of attribute. An integer that represents the CCSID for the attribute. Valid CCSID values are in the range -1 through 65535.
The special values follow:
| -1 | No CCSID value is stored with the attribute. If the attribute is QsyEncryptData, this value must be specified. |
| 0 | The default CCSID for the current user is stored. |
CCSID of data to encrypt. An integer that represents the CCSID for the data to encrypt. Valid CCSID values are in the range 1 through 65535.
The special value follows:
| 0 | The default CCSID for the current user is stored. |
CCSID of data. An integer that represents the CCSID for the entry data. Valid CCSID values are in the range 1 through 65535.
The special value follows:
| 0 | The default CCSID for the current user is stored. |
CCSID of entry ID. An integer that represents the CCSID for the entry ID. Valid CCSID values are in the range 1 through 65535.
The special value follows:
| 0 | The default CCSID for the current user is stored. |
Data. The data to store in the validation list entry.
Data to encrypt. The data to be encrypted before storing it in the validation list entry.
Displacement to attribute data. The displacement in the attribute entry to the start of the attribute data information.
Displacement to attribute ID. The displacement in the attribute entry to the start of the attribute ID value.
Entry ID. The data that is used to identify this entry in the validation list.
Length of attribute. The number of bytes of data in the attribute value. The length must be greater than 0. For the QsyEncryptData attribute, the length must be 1.
Length of attribute data. The number of bytes of data in the attribute data structure. The length must be greater than 0.
Length of attribute entry. The length (in bytes) of the current entry. This length can be used to access the next entry, and must be a multiple of 4.
Length of attribute ID. The number of bytes of data in the attribute ID. The length must be greater than 0.
Length of data to encrypt. The number of bytes of data to be encrypted and stored in this validation list entry. Possible values are 0 through 600. If the length is 0, no encrypted data will be stored in the entry.
Length of data. The number of bytes of data to be stored in this validation list entry. Possible values are 0 through 1000. If the length is 0, no data will be stored in the entry.
Length of entry ID. The number of bytes of data that is provided as the entry ID. Possible values are 1 through 100.
Number of attributes. The number of attributes to be added. This value must be greater than or equal to 0. If this value is 0, then no attributes will be added to the entry.
Reserved. This is an ignored field.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPF226A E | Validation list entry already exists. |
| CPF226D E | Not all information stored. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R1
[ Back to top | Security APIs | APIs by category ]