Changes between Version 4 and Version 5 of Documentation/ARexxAPI/MAILREAD


Ignore:
Timestamp:
Feb 5, 2014 10:19:13 AM (10 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILREAD

    v4 v5  
    1 [[TranslatedPages]]\\ 
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]] 
    3  
     1[[TranslatedPages]] 
     2[[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]] 
    43== MAILREAD 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     MailRead -- Load the current message in the Read window.  (V2.0) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,WINDOW/N,QUIET/S 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Loads the current message into the Read window, or activates an 
    1413     already opened Read window to let other commands act upon it 
    1514     afterwards. 
    1615 
    17 '''INPUTS''' 
    18      VAR/K      - alternative variable to put the results into instead of RESULT\\ 
    19      STEM/K     - base name used for the stem where the returned data will be stored\\ 
    20      WINDOW/N   - change the command behavior to just activate an already opened Read window\\ 
    21      QUIET/S    - force the window to stay invisible\\ 
     16 INPUTS:: 
     17     `VAR/K`      - alternative variable to put the results into instead of `RESULT`\\ 
     18     `STEM/K`     - base name used for the stem where the returned data will be stored\\ 
     19     `WINDOW/N`   - change the command behavior to just activate an already opened Read window with the supplied identifier\\ 
     20     `QUIET/S`    - force the window to stay invisible\\ 
    2221 
    23 '''RETURNS''' 
    24      VAR          - info returned by the command\\ 
    25      <STEM>WINDOW - number of the Read window now active\\ 
     22 RETURNS:: 
     23     `VAR`          - info returned by the command\\ 
     24     `<STEM>WINDOW` - number of the Read window now active\\ 
    2625 
    27      RC is set to 10 if WINDOW is used with a value referring to an 
     26     `RC` is set to 10 if WINDOW is used with a value referring to an 
    2827     inexistant window or if another slot is asked but all of them 
    2928     are already taken. 
    3029 
    31 '''NOTES''' 
     30 NOTES:: 
    3231     For all intents and purposes, the status of the "Multiple windows" 
    3332     flag in the Read configuration is irrelevant for this command. 
     
    3635     all four are occupied, and remain in use until the relevant window 
    3736     is closed (an "invisible" Read window is also "open" within this 
    38      context).  The optional WINDOW parameter sets the '''active''' Read window, 
    39      upon which the [[ARexx API/READCLOSE| READCLOSE ]], [[ARexx API/READINFO| READINFO ]],  
    40      [[ARexx API/READPRINT| READPRINT ]] and [[ARexx API/READSAVE| READSAVE ]] 
     37     context).  The optional `WINDOW` parameter sets the '''active''' Read window, 
     38     upon which the [[READCLOSE]], [[READINFO]],  
     39     [[READPRINT]] and [[READSAVE]] 
    4140     commands will act when called; therefore, the MAILREAD command 
    4241     '''should''' be called before using any of them to ensure they act on 
     
    4544     of the above mentioned commands. 
    4645 
    47      Until V2.5 the WINDOW/N parameter and return code was limited to 
     46     Until V2.5 the `WINDOW` parameter and return code was limited to 
    4847     return values only between 0 - 3. 
    4948 
    50 '''EXAMPLE''' 
     49 EXAMPLE:: 
    5150 
    52 '''BUGS''' 
    53      The WINDOW input parameter was never honoured; this was fixed 
     51 BUGS:: 
     52     The `WINDOW` input parameter was never honoured; this was fixed 
    5453     in V2.4. 
    5554 
    56 '''SEE ALSO''' 
    57      [[ARexx API/READCLOSE| READCLOSE ]] 
     55 SEE ALSO:: 
     56     [[READCLOSE]] [[READINFO]] [[READPRINT]] [[READSAVE]]