Please enable JavaScript to view this site.

ESL Documentation

Prototype

subroutine EcsReadLine(integer:Row, string:LineContents)

Description

Line-oriented.Copies the contents of a line into a string variable.

Parameters

Row

Input

An integer denoting the line on the screen to read. The number must be greater than zero and less than or equal to the number of lines on the screen.

LineContents

Output

A reference to a string that will receive the text from the specified line.

Return Value

ECS_E_NOTINIT

Not initialized - command was ignored

ECS_E_NOTCONN

Not connected to an active session

ECS_E_LINENUM

Invalid line number

ECS_E_ERRORFREE

No errors were generated

Example

###***************************************

###  Action to Read a Line from the screen

###***************************************

action ReadLine is

    copy text of LineNum_SB in Read_DB to LineNum_IV

    call EcsReadLine ( LineNum_IV, String_SV )

    copy errorlevel to ErrorLevel_IV

    copy "EcsReadLine" to Call_SV

    if ( ErrorLevel_IV = ECS_E_ERRORFREE )

    then

        copy "Read line was successful" to Message_SV

        clear Emulator_TR

        add to Emulator_TR

            move to 1 1

            insert String_SV

        action DisplayMessage

    else

        action DisplayError

    end if