| 1 | Major structure | Input | Char(*) |
| 2 | Major structure length | Input | Binary(4) |
| 3 | Field ID | Input | Binary(4) |
| 4 | Row | Input | Binary(4) |
| 5 | Column | Input | Binary(4) |
| 6 | Command buffer handle | Input | Binary(4) |
| 7 | Low-level environment handle | Input | Binary(4) |
| 8 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Write Structured Field Major (QsnWrtSFMaj) API writes the major structure of a structured field, setting the display address to the given row and column. If a command buffer is specified that does not contain a previous or current WTD operation, one is implicitly added to the buffer using the control characters QSN_CC1_NULL and QSN_CC2_UNLOCKBD.
Use this API in conjunction with the Write Structured Field Minor (QsnWrtSFMin) API to construct a structured field operation. For indirect operations, the length contained in the minor structure data parameter is added to the stored length for this major structure for every indirect QsnWrtSFMin operation encountered directly after this operation. In this way, you need only calculate the length of each individual structure for constructing a structured field operation. See the 5494 Remote Control Unit Functions Reference, SC30-3533, for more information regarding structured fields.
This command corresponds indirectly to the 5250 Write to Display (WTD) command with a Set Buffer Address and a Write to Display Structured Field order if the row and column are specified. (For an indirect operation, a WTD is placed in the command buffer only if one does not already exist in the buffer.)
None
If window mode is not set and the data (including attributes) exceeds the length of a row, the data will be wrapped to the next line. If bottom-to-top wrapping is not supported, a CPFA308 error occurs when the data (including attributes) exceeds the last row on the screen.
Not all structured field types are supported by all devices. A negative response code is issued if an attempt is made to write a type to a device that does not support it.
The major structure to be written to the screen. The data must consist of the entire major structure as documented in the 5494 Remote Control Unit Functions Reference, SC30-3533.
The length of the major structure parameter. This is the length only and does not include any associated minor structure lengths.
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. If neither the field ID nor the row and column parameters are specified, the current display address is used.
The row at which to write the structure. 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 data is written starting at the current display address. If this is the case and the command is a direct operation, or the buffer specified does not contain a preceding output operation that sets the display address, the current display address is set to row 1, column 1 prior to writing the data.
Row and column must both be specified or omitted; one cannot be specified if the other is omitted.
The column at which to write the data. 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.
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 data is written to the screen at the specified location. 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. |
| CPFA308 E | Attempt to write data past end of display. |
| CPFA31D E | Attempt to write outside of window area. |
| 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. |
| CPFA341 E | Length &2 of structure incorrect. |
| 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. |
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]