Display Directory Panels (QOKDSPDP) API
Required Parameter Group:
| 1 | User ID | Input | Char(8) |
| 2 | User address | Input | Char(8) |
| 3 | Title | Input | Char(10) |
| 4 | Function key processing | Output | Char(10) |
| 5 | Message to be displayed | Input | Char(*) |
| 6 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Display Directory Panels (QOKDSPDP) API has the ability to display the Add Directory Information and Change Directory Information displays. It can run that function interactively without using an administration interface. This API is for interactive use only.
Authorities and Locks
If you have security administrator (*SECADM) authority, you can change all the directory information. If you do not have security administrator authority, then you can only change your own directory information.
Required Parameter Group
- User ID
- INPUT; CHAR(8)
The user ID to be processed. The ID needs to be in character set 697, code page 500, and monocase.
- User address
- INPUT; CHAR(8)
The address of the user to be processed. The address needs to be in character set 697, code page 500, and monocase.
- Title
- INPUT; CHAR(10)
The type of directory panel to be displayed. The following are the possible values:
*CHG Change directory information *ADD Add directory information
- Function key processing
- OUTPUT; CHAR(10)
The operation processed for the key pressed. This indicates what type of ending processing to do. The following are the possible values:
*ENTER The enter operation is processed. *F3 The exit operation is processed. *F12 The previous display is shown.
- Message to be displayed
- INPUT; CHAR(*)
A structure with a message ID and replacement text that is to be shown on the display. If the message size is 0, no message will be displayed. For the format of the structure, see Message to Be Displayed Format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Message to Be Displayed Format
The format of the message to be displayed parameter is as follows:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(2) | Message size |
| 2 | 2 | CHAR(7) | Message ID |
| 9 | 9 | CHAR(8) | Message file |
| 17 | 11 | CHAR(4) | Message type |
| 21 | 15 | BINARY(2) | Length of message data |
| 23 | 17 | CHAR(*) | Message data |
Field Descriptions
Length of message data. The length of the message data. The maximum length is 256.
Message data. The data to be replaced in the message. The maximum size is 256.
Message file. The message file name where the message is displayed from. When the message is sent, it picks up the message library from *LIBL.
Message ID. The message ID of the message to be displayed.
Message size. The total length of the message to be displayed format. If this value is greater than zero, the message will be sent.
Message type. The message type of the message to be signaled. The valid values are:
| INFO | Informational |
| DIAG | Diagnostic |
| ESCP | Escape |
| COMP | Completion |
| NTFY | Notify |
| STAT | Status |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF89A0 E | Values passed to QOKDSPDP are not valid |
| CPF9024 E | System cannot get correct record to finish operation. |
| CPF9054 E | Description '&1' already exists. |
| CPF9083 E | User ID and address &1 &2 not changed. |
| CPF9810 E | Library &1 not found. |
| CPF9830 E | Cannot assign library &1. |
| CPF9845 E | Error occurred while opening file &1. |
| CPF9846 E | Error while processing file &1 in library &2. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R2
[ Back to top | Office APIs | APIs by category ]