Changes between Version 3 and Version 5 of Documentation/ARexxAPI/READSAVE


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/READSAVE

    v3 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== READSAVE
    54
    6 '''NAME'''
     5 NAME::
    76     ReadSave -- Save a part of the message in the active Read window to a file.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     PART/N,FILENAME/K,OVERWRITE/S
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Saves a part of the message in the active Read window to a file.
    1413
    15 '''INPUTS'''
    16      PART/N        - part of the message to save, possible values are 1 for the first part of the message (usually the body), 2 or higher for further parts, or no value at all to get a printout of the visible part of the message\\
    17      FILENAME/K    - filename to use\\
    18      OVERWRITE/S   - avoid any security requesters opened due to an already existing file\\
     14 INPUTS::
     15     `PART/N`        - part of the message to save, possible values are 1 for the first part of the message (usually the body), 2 or higher for further parts, or no value at all to get a printout of the visible part of the message\\
     16     `FILENAME/K`    - filename to use\\
     17     `OVERWRITE/S`   - avoid any security requesters opened due to an already existing file\\
    1918
    20 '''RETURNS'''
    21      RC is set to 10 if the specified part doesn't exist, if the file
     19 RETURNS::
     20     `RC` is set to 10 if the specified part doesn't exist, if the file
    2221     couldn't be written to or if no Read window was previously specified
    23      as "active" with [[ARexx API/MAILREAD| MAILREAD ]].
     22     as "active" with [[MAILREAD]].
    2423
    25 '''NOTES'''
     24 NOTES::
    2625
    27 '''EXAMPLE'''
    28          /* Enable result codes */
     26 EXAMPLE::
     27     {{{#!arexx
     28     /* Enable result codes */
     29     OPTIONS RESULTS
    2930
    30          OPTIONS RESULTS
     31     /* Silently decode the current message */
     32     MAILREAD QUIET
    3133
    32          /* Silently decode the current message */
     34     /* Save the body to a file, then close the message */
     35     READSAVE 1 FILENAME 'mail:important'
     36     READCLOSE
     37     }}}
    3338
    34          MAILREAD QUIET
    35 
    36          /* Save the body to a file, then close the message */
    37 
    38          READSAVE 1 FILENAME 'mail:important'\\
    39          READCLOSE\\
    40 
    41 '''BUGS'''
     39 BUGS::
    4240     The command used to blindly act upon the first Read window opened
    4341     at any given time; this was changed in V2.4 to require the use
    44      of [[ARexx API/MAILREAD| MAILREAD ]] to explicitely mark a window as "active".
     42     of [[MAILREAD]] to explicitely mark a window as "active".
    4543
    46 '''SEE ALSO'''
    47      [[ARexx API/MAILREAD| MAILREAD ]], [[ARexx API/READINFO| READINFO ]]
     44 SEE ALSO::
     45     [[MAILREAD]], [[READINFO]]