SCRNSAVE

8.0.4, ANSI

The SCRNSAVE instruction saves the entire contents of a screen plus the screen state information. The instruction uses the following format:

Where:

label

Optional. A Program Execution Label.

screen

Required. A previously defined Character String Variable in which the entire contents of a screen plus the screen state information is saved.

Flags Affected: EOS

Note the following:

1. The information is saved starting at the first position of {screen}. The Form Pointer is set to one (1) and the Length Pointer is set to the last character moved.

2. The size required for the {screen} variable may be determined by using the SCRNSIZE instruction.

3. If {screen} is not large enough to hold the entire contents, the EOS flag is set.

4. The information saved includes the characters and attributes of the entire screen, the current subwindow parameters, the cursor position, the echo secret character, the color and display attributes, and the KEYIN case conversion mode.

5. The information is saved in row major order.

6. The current cursor position is not affected.

7. Use of this instruction on Linux systems requires subwindow emulation in the screen definition file.

See Also: SCRNSAVE, SCRNSIZE, Interactive I/O Instructions