WIN ( GETSCREEN )

Get Attributes for Entire Screen

This string function returns the text and attribute strings for the entire terminal screen.

Syntax

WIN ( GETSCREEN )

Remarks

This function is generally available starting with release level 8.1.

If you use this function but Thoroughbred Basic Windows is not enabled, an ERR=70 results. For information on how to enable Thoroughbred Basic Windows, please refer to the information on TCONFIG files and IPL files in the chapter on System Files in the Thoroughbred Basic Customization and Tuning Guide.

The format of the returned string is:

Byte(s): Description
1 - 2: Binary number of screen maps to follow.
3 - 4: Binary number of bytes per map.
5 - n: Map type and contents:

First 2 bytes: binary map type.

0 = text map
1 = attribute map
2 = color map

Third byte and beyond: map characters, row by row, for length specified in bytes 3 - 4 of full string

5 + 2 +
(value of 3 - 4) The next map.

The attribute map contains one byte for every byte of text. Each bit in the attribute byte signifies a different characteristic for the byte of text. Considering the rightmost bit to be bit 0, their meanings are:

bit 0 = 0 when background, 1 when foreground
bit 1 = 0 when normal video, 1 when reverse video
bit 2 = 0 when underline off, 1 when underline on
bit 3 = 0 when steady, 1 when blink
bit 4 = not used
bit 5 = 0 when graphics mode off, 1 when graphics mode on
bits 6-7 = not used

WIN ( GETSCREEN )

Syntax

Remarks

See also