| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | List information | Output | Char(80) |
| 4 | Number of records to return | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | User name | Input | Char(10) |
| 7 | Error code | I/O | Char(*) |
The Open List of User Certificates (QSYOLUC) API provides a list of user certificates associated with a user.
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. For more information about the format of the data returned in the receiver variable, see Certificate Format CERT0100 (ASN.1) and Certificate Format CERT0200 (Plain Text).
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. For formats that contain variable length data, the receiver variable length must be large enough to hold the fixed portion of the record.
The variable that is used to return status information about the list of user certificates that were opened. See Format of List Information for a description of this parameter.
The number of records containing a user certificate to return. The value -1 indicates that all the records containing user certificates should be returned.
The name of the format that is used to list user certificates.
The possible format names are:
| CERT0100 | Certificates in ASN.1 format in ASCII encoding. |
| CERT0200 | Certificates in plain text format. Character fields are encoded in the job CCSID. |
The name of the user profile.
The following is a valid selection:
| *CURRENT | The user profile that is currently running. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Total records |
| 4 | 4 | BINARY(4) | Records returned |
| 8 | 8 | CHAR(4) | Request handle |
| 16 | 10 | CHAR(1) | Information complete indicator |
| 17 | 11 | CHAR(13) | Date and time created |
| 30 | 1E | CHAR(1) | List status indicator |
| 31 | 1F | CHAR(1) | Reserved |
| 32 | 20 | BINARY(4) | Length of information returned |
| 36 | 24 | BINARY(4) | First record in buffer |
| 44 | 2C | CHAR(36) | Reserved |
Date and time created. The date and time when the list was created.
The 13 characters are:
| 1 | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| 2-7 | The date, in YYMMDD (year, month, and day) format. |
| 8-13 | The time of day, in HHMMSS (hours, minutes, and seconds) format. |
First record in buffer. The number of the first record in the receiver variable.
Information complete indicator. Whether all requested information has been supplied.
Possible values follow:
| I | Incomplete information. An interruption causes the list to contain incomplete information about a buffer or buffers. |
| P | Partial and accurate information. Partial information is returned when the maximum space was used and not all of the buffers requested were read. |
| C | Complete and accurate information. All the buffers requested are read and returned. |
Length of information returned. The size, in bytes, of the information that is returned in the receiver variable.
List status indicator. The status of building the list.
The possible value follows:
| 2 | The list has been completely built. |
Records returned. The number of records returned in the receiver variable. This is the smallest of the following three values:
Request handle. The handle of the request that can be used for subsequent requests of information from the list. The handle is valid until the Close List (QGYCLST) API is called to close the list, or until the job ends.
Note: This field should be treated as a hexadecimal field. It should not be converted from one CCSID to another, for example, EBCDIC to ASCII, because doing so could result in an unusable value.
Reserved. An ignored field.
Total records. The total number of records available in the list.
| Message ID | Error Message Text |
|---|---|
| CPFA0AA E | Error occurred while attempting to obtain space. |
| CPF1F41 E | Severe error occurred while addressing parameter list. |
| CPF2204 E | User profile &1 not found. |
| CPF2213 E | Not able to allocate user profile &1. |
| CPF2217 E | Not authorized to user profile &1. |
| CPF2222 E | Storage limit is greater than specified for user profile &1. |
| CPF227E E | Selection control is not valid. |
| CPF3BFF E | Required option &1 is not available. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF4AB9 E | User certificate function not successful. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Security APIs | APIs by category ]