| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | User ID | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
The Retrieve Profile Exit Programs (QWTRTVPX) API retrieves the profile exit flags, based on the format, that have been designated to be called for the specified user ID. The QWTRTVPX API then places that information into a single variable in the calling program. The amount of information placed in the variable depends on the size of the variable.
None.
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 format of the profile exit program information to be returned. You can use this format:
| ATTN0100 | Preattention information. For details, see ATTN0100 Format. |
| SREQ0100 | Presystem request information. For details, see SREQ0100 Format. |
The user ID being retrieved. Valid values are as follows:
| *CURRENT | The user ID of the job that is currently running. |
| User ID name | The 10-character name that is entered. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table describes the information that is returned in the receiver variable for the ATTN0100 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Entries returned |
| 4 | 4 | BINARY(4) | Entries available |
| ARRAY (*) of BINARY(4) | Array of entries | ||
Array of entries. An array of entries where the first entry corresponds to exit program number one for the exit point QIBM_QWT_PREATTNPGMS and format ATTN0100 in the registration facility. The second entry in the array corresponds to exit program number 2 and so on. The possible returned values are as follows:
| 0 | No, do not call this exit program. |
| 1 | Yes, call this exit program. |
Entries available. The number of possible entries being returned. All available data is returned if enough space is provided.
Entries returned. The actual number of entries that is being returned. If the data is truncated because the receiver variable is not large enough to hold all of the data available, this value is less than the entries available.
The following table describes the information that is returned in the receiver variable for the SREQ0100 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Entries returned |
| 4 | 4 | BINARY(4) | Entries available |
| ARRAY (*) of BINARY(4) | Array of entries | ||
Array of entries. An array of entries where the first entry corresponds to exit program number one for the exit point QIBM_QWT_SYSREQPGMS and format SREQ0100 in the registration facility. The second entry in the array corresponds to exit program number 2 and so on. The possible returned values are as follows:
| 0 | No, do not call this exit program. |
| 1 | Yes, call this exit program. |
Entries available. The number of possible entries being returned. All available data is returned if enough space is provided.
Entries returned. The actual number of entries that is being returned. If the data is truncated because the receiver variable is not large enough to hold all of the data available, this value is less than the entries available.
| Message ID | Error Message Text |
|---|---|
| CPF2204 E | User profile &1 not found. |
| CPF2213 E | Not able to allocate user profile &1. |
| CPF2217 E | Not authorized to user profile &1. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |