# READSCREEN()

Syntax:

Then: XX=READSCREEN(filename,screenname[,section])

"filename" is the name of the filePro file
"screenname" is the screen name.

The optional third parameter is the section of the screen to be read.

Version Ref: 4.8 (not included in filePro Lite)

5.0(Enhanced)

Description:

READSCREEN returns the text portion of a screen as a single 1600 character field.

Currently supported sections are:

Third parameter options

0: Graphics characters are returned as text equivalents. (i.e., '|', '-', '+')
1: Graphics characters are returned as is.
2: Graphics characters are returned as spaces.

3 = Return only the graphics characters, as "+-|" text.

4 = Return only the graphics characters, as-is.

5 = Return size information of the screen.

Ø width

Ø height

Ø format type

Ø records across page

Ø records down page

Ø number of header lines

Ø number of footer lines (always zero for now)

Ø number of data lines

Ø number of break levels (including grand total)

Ø 9 entries, one for each break level, innermost first

6 = Return the color attributes as a 1600-character field.

Notes:

Section codes are optional parameters and if left blank will default to code "0".

If the screen cannot be read (ie: doesn't exist) then READSCREEN() returns a null value. For code 0, text equivalents for graphic characters are '|', '-', '+'.

Codes 3 through 6 were added as a version 5.0 enhancement. For codes 3 and 4, all regular text is returned as spaces.

If the screen cannot be read (i.e., doesn't exist), then READSCREEN() returns a null value.