Changes between Initial Version and Version 1 of Documentation/ARexxAPI/READSAVE


Ignore:
Timestamp:
Sep 23, 2013 8:48:18 PM (10 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/READSAVE

    v1 v1  
     1== READSAVE 
     2 
     3'''NAME''' 
     4     ReadSave -- Save a part of the message in the active Read window to a file.  (V2.0) 
     5 
     6'''TEMPLATE''' 
     7     PART/N,FILENAME/K,OVERWRITE/S 
     8 
     9'''FUNCTION''' 
     10     Saves a part of the message in the active Read window to a file. 
     11 
     12'''INPUTS''' 
     13     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\\ 
     14     FILENAME/K    - filename to use\\ 
     15     OVERWRITE/S   - avoid any security requesters opened due to an already existing file\\ 
     16 
     17'''RETURNS''' 
     18     RC is set to 10 if the specified part doesn't exist, if the file 
     19     couldn't be written to or if no Read window was previously specified 
     20     as "active" with [[rx_mailread| MAILREAD ]]. 
     21 
     22'''NOTES''' 
     23 
     24'''EXAMPLE''' 
     25         /* Enable result codes */ 
     26 
     27         OPTIONS RESULTS 
     28 
     29         /* Silently decode the current message */ 
     30 
     31         MAILREAD QUIET 
     32 
     33         /* Save the body to a file, then close the message */ 
     34 
     35         READSAVE 1 FILENAME 'mail:important'\\ 
     36         READCLOSE\\ 
     37 
     38'''BUGS''' 
     39     The command used to blindly act upon the first Read window opened 
     40     at any given time; this was changed in V2.4 to require the use 
     41     of [[rx_mailread| MAILREAD ]] to explicitely mark a window as "active". 
     42 
     43'''SEE ALSO''' 
     44     [[rx_mailread| MAILREAD ]], [[rx_readinfo| READINFO ]]