Please enable JavaScript to view this site.

ESL Documentation

Prototype

subroutine EcsWriteFieldRowCol(integer:Row, integer:Col, string:Data, integer:Fill)

Description

Copies a string into a field located in a specified row and column.

Parameters

Row

Input

An integer that specifies line on the screen where the field resides.

Col

Input

An integer that specifies the position within the line where the field is.

Data

Input

The text to be typed into the specified field.

Fill

Input

An integer flag that determines how the field will be completed, if the string is not longer enough to complete the space available. The options are: ECS_NOFILL - characters will be left unchanged, ECS_FILLWITHNULLS - remaining characters will be replaced by NULLs, ECS_FILLWITHBLANKS- remaining characters will be replaced by blanks.

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

The row, column co-ordinates are not within the boundary of the screen

ECS_E_PROTFLD

Attempt to write protected field

ECS_E_FILLSWITCH

Invalid fill switch specified

ECS_E_ERRORFREE

No errors were generated

Example

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

###  Actions to Write to a field at Position

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

action WriteFieldAtPosition is

    copy text of String_MLE in Write_DB to String_SV

    copy value of Row_SB in Write_DB to Row_IV

    copy value of Column_SB in Write_DB to Column_IV

    extract from text of FillOptions_CMB

        skip by 38

        take by number FillOptions_IV

    call EcsWriteFieldRowCol ( Row_IV, Column_IV, String_SV, FillOptions_IV )

    copy errorlevel to ErrorLevel_IV

    copy "EcsWriteFieldRowCol" to Call_SV

    if ( ErrorLevel_IV = ECS_E_ERRORFREE ) then

        copy "Type string was successful" to Message_SV

        action DisplayMessage

    else

        action DisplayError

    end if