| 1 | Message | Input | Char(*) |
| 2 | Message length | Input | Binary(4) |
| 3 | Field ID | Input | Binary(4) |
| 4 | Cursor row | Input | Binary(4) |
| 5 | Cursor column | Input | Binary(4) |
| 6 | Starting monochrome attribute | Input | Char(1) |
| 7 | Ending monochrome attribute | Input | Char(1) |
| 8 | Starting color attribute | Input | Char(1) |
| 9 | Ending color attribute | Input | Char(1) |
| 10 | Command buffer handle | Input | Binary(4) |
| 11 | Low-level environment handle | Input | Binary(4) |
| 12 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Set Error State (QsnSetErr) API places the keyboard into prehelp error state and optionally places a string on the error line. To place the keyboard in the prehelp error state, you must follow this API with an AID-associated read API such as QsnReadInp.
Either the cursor or the message parameters must be specified to make the command valid. If neither of these are used, a CPFA305 error is issued. If a cursor position is specified, the cursor is moved immediately to the location given. This does not affect the cursor address set by the Insert Cursor (QsnInsCsr) API.
When the operator presses the Help key (prehelp error state only) in response to the error condition, the message No help text is available is displayed.
This command corresponds directly to the 5250 Write Error Code command.
None
The message to be displayed. This parameter is required if the message length parameter is specified as a nonzero value. The message data, including the screen attributes, must not exceed 132 characters for devices that are in 27x132 mode, or 80 characters for all other devices. A CPFA310 error is issued if the message data is too long.
The number of bytes of message data to be displayed.
The field ID indicating the field at which to set the display address. If this parameter is specified with a nonzero value, the row and column parameters are ignored and the row and column values corresponding to the field ID are used to set the display address.
The row at which to position the cursor when the message is displayed. The row parameter must refer to a row no greater than the current screen or window mode height (if window mode is enabled). The actual screen row used for a screen I/O operation is calculated using the formula base+offset=actual. The base is the row location of the top window border (0 for full screen) if offset is positive, or the row location of the bottom window border (screen height plus 1 for full screen) if offset is negative. The offset is the row parameter value specified, and actual is the actual screen row to be used. A CPFA307 error occurs if an incorrect row value is specified.
If both the field ID and the row and column parameters are omitted, the cursor is not moved. The row and column parameters must be specified together, or both parameters must be omitted.
The column at which to position the cursor when the message is displayed. The column parameter must refer to a column no greater than the current screen or window mode width (if window mode is on). The actual screen column used for a screen I/O operation is calculated using the formula base+offset=actual. The base is the column location of the left window border (0 for full screen) if offset is positive, or the column location of the center window border (screen width plus 1 for full screen) if offset is negative. The offset is the column parameter value specified, and actual is the actual screen column to be used. A CPFA307 error occurs if an incorrect column value is specified.
The initial screen attribute for monochrome displays. If this parameter is omitted or specified as X'00', a starting attribute of high intensity blink is inserted. See Screen Attribute Characters for a description of the screen attribute values. The starting attribute is selected as for the QsnWrtDta API.
The ending screen attribute for monochrome displays. If this parameter is omitted or specified as X'00', an ending attribute of nondisplay is inserted. The ending attribute is selected as for the QsnWrtDta API.
The initial screen attribute for color displays. If this parameter is omitted and color attributes are to be used, no initial attribute is written to the display for the data.
The ending screen attribute for color displays. If this parameter is omitted and color attributes are to be used, no ending attribute is written to the display for the data.
A handle for the command buffer in which to store the command. If this parameter is omitted or specified as 0, this is a direct operation and the error state is entered, the cursor is moved to the specified position, and the message, if specified, is displayed. Otherwise, this is an indirect operation and the command is stored in the command buffer without an I/O operation taking place.
The low-level environment that the operation applies to. If this parameter is omitted or given with a value of zero, the default low-level environment is used.
The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
| Message ID | Error Message Text |
|---|---|
| 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. |
| CPFA301 E | Command buffer is full. |
| CPFA303 E | Error occurred for screen I/O operation. |
| CPFA304 E | Data-stream error &1 reported for screen I/O operation. |
| CPFA305 E | Cannot add operation to command buffer. |
| CPFA307 E | Screen position &1, &2 outside of display or window area. |
| CPFA30D E | Invalid screen attribute. |
| CPFA30F E | Required parameter not specified. |
| CPFA310 E | Error message data/screen attributes exceed display width. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
| CPFA333 E | Parameter &1 not positive integer value. |
| CPFA334 E | Low level environment handle incorrect. |
| CPFA335 E | Screen address parameter error. |
| CPFA33C E | Undefined field ID &1. |
| CPFA33F E | Error occurred during data conversion. |
| CPFA343 E | Output operation not done. |
| CPFA344 E | The file &2 in library &3 is not valid. |
| CPFA345 E | The invite active flag is not valid. |
| Top | Dynamic Screen Manager APIs | APIs by category |