-
-
Notifications
You must be signed in to change notification settings - Fork 18
Documentation ARexxAPI MAILREAD
NAME:: MailRead -- Load the current message in the Read window. (V2.0)
TEMPLATE:: VAR/K,STEM/K,WINDOW/N,QUIET/S
FUNCTION:: Loads the current message into the Read window, or activates an already opened Read window to let other commands act upon it afterwards.
INPUTS::
VAR/K - alternative variable to put the results into instead of RESULT\
STEM/K - base name used for the stem where the returned data will be stored\
WINDOW/N - change the command behavior to just activate an already opened Read window with the supplied identifier\
QUIET/S - force the window to stay invisible\
RETURNS::
VAR - info returned by the command\
<STEM>WINDOW - number of the Read window now active\
`RC` is set to 10 if `WINDOW` is used with a value referring to an
inexistant window or if another slot is asked but all of them
are already taken.
NOTES:: For all intents and purposes, the status of the "Multiple windows" flag in the Read configuration is irrelevant for this command.
Window slots are dynamically assigned as they are required until
all four are occupied, and remain in use until the relevant window
is closed (an "invisible" Read window is also "open" within this
context). The optional `WINDOW` parameter sets the *active* Read window,
upon which the [[READCLOSE]], [[READINFO]],
[[READPRINT]] and [[READSAVE]]
commands will act when called; therefore, the MAILREAD command
*should* be called before using any of them to ensure they act on
the window that they are supposed to. Note that manually activating
a Read window using the GUI does *not* magically makes it the target
of the above mentioned commands.
Until V2.5 the `WINDOW` parameter and return code was limited to
return values only between 0 - 3.
EXAMPLE::
BUGS::
The WINDOW input parameter was never honoured; this was fixed
in V2.4.