Please enable JavaScript to view this site.

ESL Documentation

Prototype

subroutine EcsGetError( integer:ErrorLevel, string:Message )

Description

Copies the error message associated with the specified error number into a string variable.

Parameters

ErrorLevel

Input

The integer value returned by a previous ECS call.

Message

Output

A string that will receive the text equivalent of the error code.

Return Value

ECS_E_NOERROR

Error Level specified is out of range

ECS_E_ERRORFREE

No errors were generated

Example

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

###  Action to Display a message from ECS

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

action DisplayError is

    call EcsGetError ( ErrorLevel_IV, Message_SV )

   if (errorlevel = ECS_E_ERRORFREE) then

        copy ( ReplyToMessage ( Call_SV, Message_SV, MessageOK, 1, MessageWarning ) ) to String_SV

    end if