[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 SCREENSTR()
 Reads a string, including attributes, from the screen
------------------------------------------------------------------------------
 Syntax

     SCREENSTR ([<nRow>], [<nColumn>], [<nCharCount>])
         --> cCharacterstring

 Arguments

     <nRow>  Designates the first line to read.  The default is the
     cursor line.

     <nColumn>  Designates the first column to read.  The default is the
     cursor column.

     <nCharCount>  Designates how many characters to read.  The default
     is to the end of the window or screen area.

 Returns

     SCREENSTR() returns the character string that contains all of the bytes
     read from the screen.

 Description

     SCREENSTR() returns a specified portion of the screen or window
     contents.  <nRow> specifies the first line, and <nColumn> the first
     column to read from.  <nCharCount> designates the number of characters
     to read, if you do not want the entire screen or window content.

 Notes

     .  The returned character string contains all the attribute
        bytes.  For the entire screen, a variable that is 25 lines by 80
        columns, is a total of 4000 characters.

     .  If <nRow> or <nColumn> are not specified, then the function
        automatically uses the corresponding coordinates of the current
        cursor position.  The function does not change the cursor position.

 Examples

     .  Read all characters with their accompanying attributes from
        the cursor position to the end of the screen:

        cVar: = SCREENSTR()

     .  Show all characters and attributes from the cursor position in
        line 24:

        cVar: = SCREENSTR(24)

     .  The last 10 characters and attributes in line 24:

        cVar: = SCREENSTR(24, 70)

     .  The last 10 characters (without attributes) in line 24:

        cVar: = CHARODD(SCREENSTR(24, 70))


See Also: STRSCREEN() CHARODD() CHAREVEN()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson