11.23 CBL_READ_SCR

This routine acquires the specified length of a string (beginning at the specified position on the screen) and the attributes of the string characters.

Specification

Parameter data definition

01 position-on-screen.
   02 line-position      PIC 9(4) BINARY.
   02 column-position    PIC 9(4) BINARY.
01 character-buffer      PIC X(n).
01 attribute-buffer. 
   02 attribute          PIC 1(8) BIT occurs n times.
01 string-length         PIC 9(4) BINARY.
01 status-code           PIC S9(4) COMP-5.

Calling format

CALL "CBL_READ_SCR_CHATTRS"
    USING position-on-screen
          character-buffer
          attribute-buffer
          string-length
    RETURNING status-code.

Interface

line-position: Specifies a line by using a numeric value with the upper-most line assumed to be the origin (0).

column-position: Specifies a column by using a numeric value with the left-most column assumed to be the origin (0).

character-buffer: Specifies the area used to store the string to be acquired.

attribute-buffer: Specifies the area used to store the attributes to be acquired. See "11.14 CBL_WRITE_SCR_ATTRS" for information about attributes.

string-length: Specifies the length of the string to be acquired.

Return code

The return code is set in the status-code specified in the RETURNING clause.

status-code

0: Successful
Other than 0: Failure

11.23 CBL_READ_SCR_CHATTRS