| 1 | Function | Input | Char(10) |
| 2 | Format | Input | Char(10) |
| 3 | System name | Input | Char(8) |
| 4 | System group | Input | Char(8) |
| 5 | User ID | I/O | Char(8) |
| 6 | User address | I/O | Char(8) |
| 7 | Text description | Output | Char(50) |
| 8 | Key code | Output | Char(10) |
| 9 | Error code | I/O | Char(*) |
The Display Directory X.400 Panels (QOKDSPX4) API has the ability to display various X.400 O/R name panels and to process functions interactively without going through the Work with Directory panel. An O/R name is to X.400 as a user ID and address is to SNADS; that is, it is the way users are addressed in an X.400 network.
This API is for interactive use only; it cannot be used for batch programs.
The QOKDSPX4 API is shipped with *EXCLUDE public authority. If the program calling this API adopts authority, it is the responsibility of the calling program to ensure that the user has the correct authority to add X.400 O/R names.
The function requested. The following are possible values:
| *ADD | Add O/R name information |
| *DISPLAY | Display O/R name information |
This field must be blank.
The system name (REN) of the user to be associated with the O/R name to be added. The system name cannot be the local system name because local user profiles are not automatically created. If blanks are passed when FUNCTION(*ADD) is specified, the local system name will be used. This parameter is ignored when the function is (*DISPLAY).
The system group name (RGN) of the user to be associated with the O/R name to be added. This parameter is required for FUNCTION(*ADD). This parameter is required for FUNCTION(*DISPLAY) but is ignored.
The user ID (DEN) of the user associated with the function. For FUNCTION(*ADD), this is an output-only field. On the panel, the user ID (DEN) will be initialized to *GEN. The user may override this with a specified user ID, or a user ID will be generated. For *GEN, the generated user ID is the value returned in this field. Otherwise, the value in this field when Enter is pressed is the value returned. For FUNCTION(*DISPLAY), this is an input-only field.
The user address (DGN) of the user associated with the function. For FUNCTION(*ADD), this is an output-only field. On the panel, the user address will be initialized to the system name value that is specified on this API. The user can change the user address. The value in this field when Enter is pressed is the value returned in this field. For FUNCTION(*DISPLAY), this is an input-only field.
The description of the directory entry associated with the O/R name added. This parameter is valid only for FUNCTION(*ADD).
The key code (F3, F12, Enter) from the X.400 panel. The following are possible values:
| *F3 | F3 was pressed on the X.400 panel |
| *F12 | F12 was pressed on the X.400 panel |
| *ENTER | Enter was pressed on the X.400 panel |
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF89A3 E | Operation not successful due to authority reasons. |
| CPF89A4 E | Operation not successful due to data validation reasons. |
| CPF89A7 E | Error associated with exit program. Reason code &3. <</td> |
| CPF898A E | X.400 O/R name does not exist for this directory entry. </</td> |
| CPF9A8C E | Error occurred with QOKSCHD API. Reason code &1. |
| CPF9A82 E | Values passed to QOKDSPX4 not valid. |
| CPF9082 E | User ID and address &1 &2 not added to directory. |
| 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. |
[ Back to top | Office APIs | APIs by category ]