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


Ignore:
Timestamp:
Sep 23, 2013 8:22:31 PM (7 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/NEWMAILFILE

    v1 v1  
     1== NEWMAILFILE 
     2 
     3'''NAME''' 
     4     NewMailFile -- Return a valid, but unused message filename for a folder.  (V2.0) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,FOLDER 
     8 
     9'''FUNCTION''' 
     10     Returns a valid but still unused message filename for a folder, 
     11     based on the current date.  This is the filename that YAM will 
     12     use when adding the next message to this folder. 
     13 
     14'''INPUTS''' 
     15     VAR/K    - alternative variable to put the results into instead of RESULT\\ 
     16     STEM/K   - base name used for the stem where the filename will be returned\\ 
     17     FOLDER   - optional, name or number of the folder; if none if supplied, the current folder will be used\\ 
     18 
     19'''RETURNS''' 
     20     VAR            - filename returned, with path\\ 
     21     <STEM>FILENAME - filename returned, with path\\ 
     22 
     23     RC is set to 10 if the specified folder doesn't exist or a group 
     24     is currently selected. 
     25 
     26'''NOTES''' 
     27     The command works by trying to lock the first message slot usable for 
     28     the current date (e.g. Work:YAM/folder_name/09097.001 for Nov 28, 2002) 
     29     and then working from there until the lock fails. 
     30 
     31'''EXAMPLE''' 
     32 
     33'''BUGS''' 
     34 
     35'''SEE ALSO'''