| 1 | Input buffer containing saved data | Input | Binary(4) |
| 2 | Command buffer handle | Input | Binary(4) |
| 3 | Low-level environment handle | Input | Binary(4) |
| 4 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Restore Screen (QsnRstScr) API restores the state of the display as saved with an indirect command. The display will be restored using the data contained in the input buffer given by parameter 1. If an indirect operation is specified, the resulting command buffer will contain the Restore Screen command and the data to restore the screen. Additional commands can be added to the command buffer subject to the conditions described in Restrictions.
This command corresponds directly to the 5250 Restore Screen or Restore Partial Screen command. See the 5250 data stream documentation for details.
None.
This command must be the last command in the command buffer except when GUI support is used. In this case, other input commands may follow.
An input buffer that contains the result of an indirect QsnSavScr operation. The data will be copied from this input buffer and used for the restore screen operation.
If this parameter is omitted or specified as 0, this is a direct operation and the screen is restored immediately. 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. |
| CPFA316 E | Saved data not valid. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
| CPFA334 E | Low level environment handle incorrect. |
| CPFA343 E | Output operation not done. |
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]