CBL_READ_SCR_CHARS

Restriction:

This routine is supported for native COBOL only.
This routine is not supported when CHARSET"EBCDIC" is in effect.

Reads a string of characters from the screen.

Syntax:

call "CBL_READ_SCR_CHARS" using     screen-position
                                    character-buffer
                                    string-length
                          returning status-code

Parameters

screen-position

Group predefined as cblt-screen-position containing:

01 cblt-screen-position   typedef.
  03 cblte-scrp-row       cblt-x1-compx. 	*> pic x comp-x.
  03 cblte-scrp-col       cblt-x1-compx. 	*> pic x comp-x.

character-buffer

Call prototype (see Key): pic x (n).

Picture: pic x (n).

string-length

Call prototype (see Key): cblt-x2-compx.

Picture: pic x(2) comp-x.

status-code

See Library Routines - Key.

On Entry:

`screen-position`	The screen position to start reading at. The top left corner is row 0, column 0. See Screen Routines.
`string-length`	The length of the string to read.

On Exit:

`character-buffer`	The characters read from the screen. This data item must be at least as long as specified by `string-length`; positions in it beyond that length are unchanged.
`string-length`	If the end of the screen is reached, the length read is returned in here.