| 1 | Minor structure | Input | Char(*) |
| 2 | Minor structure length | Input | Binary(4) |
| 3 | Command buffer handle | Input | Binary(4) |
| 4 | Low-level environment handle | Input | Binary(4) |
| 5 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Write Structured Field Minor (QsnWrtSFMin) API writes the minor structure of a structured field, incrementing the length field in the corresponding major structure by the length of this minor structure. The QsnWrtSFMin API must directly follow a QsnWrtSFMaj or QsnWrtSFMin operation to the given command buffer.
Use this API in conjunction with the Write Structured Field Major (QsnWrtSFMaj) 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.
None.
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 minor structure to be written to the screen. The data must consist of the entire minor structure as documented in the 5494 Remote Control Unit Functions Reference, SC30-3533.
The length of the minor structure.
A handle for the command buffer in which to store the command. The last operation stored in this command buffer must have been either a QsnWrtSFMaj or QsnWrtSFMin operation.
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. |
| CPFA30D E | Invalid screen attribute. |
| 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. |
| CPFA33B E | Incorrect operation before QsnWrtSFMin. |
| 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 ]