Output Text to Learn File

This Subprogram outputs the specified text string to the Learn File if this is currently enabled. Otherwise it is ignored.

Short Name Calling Sequence

STATUS = UIOULE(TEXT)

Long Name Calling Sequence

STATUS = UI_OUTPUT_LEARN(...)

Input Arguments

TEXT (Character) Text String

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALISED ) Package not Initialized UININI )

UI__WRITE_OUTPUT ) Unable to Write to UICOWR ) Output File

Note:

1. The call will be ignored if Learn Mode is not enabled or UIPACK is currently executing an Indirect Command File (Learning is disabled whilst executing such files).
2. No check is made to ensure that the specified text string is valid (i.e. will form valid input when accessed from the generated Indirect Command File).