Please enable JavaScript to view this site.

ESL Documentation

Prototype

subroutine EcsReadField(integer:FieldNumber, string:FieldContents)

Description

Field-oriented.Copies the contents of the specified field into a string variable.

Parameters

FieldNumber

Input

An integer denoting the field to be read that must be greater than zero and less than or equal to the number of fields on the screen.

FieldContents

Output

A reference to the string that will receive the content of the specified field.

Return Value

ECS_E_NOTINIT

Not initialized - command was ignored

ECS_E_NOTCONN

Not connected to an active session

ECS_E_NOFLDS

Screen contains no fields

ECS_E_FLDNUM

Invalid field number

ECS_E_ERRORFREE

No errors were generated

Example

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

###  action to read a field

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

action ReadField is

    copy text of FieldNum_SB in Read_DB to FieldNum_IV

    call EcsReadField ( FieldNum_IV, String_SV )

    copy errorlevel to ErrorLevel_IV

    copy "EcsReadField" to Call_SV

    if ( ErrorLevel_IV = ECS_E_ERRORFREE ) then

        copy "Read was successful" to Message_SV

        action DisplayMessage

    else

        action DisplayError

    end if