Changes between Version 3 and Version 4 of Documentation/ARexxAPI/NEWMAILFILE


Ignore:
Timestamp:
Feb 5, 2014, 10:44:29 AM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/NEWMAILFILE

    v3 v4  
    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== NEWMAILFILE
    54
    6 '''NAME'''
     5 NAME::
    76     NewMailFile -- Return a valid, but unused message filename for a folder.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K,FOLDER
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Returns a valid but still unused message filename for a folder,
    1413     based on the current date.  This is the filename that YAM will
    1514     use when adding the next message to this folder.
    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 filename will be returned\\
    20      FOLDER   - optional, name or number of the folder; if none if supplied, the current folder will be used\\
     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 filename will be returned\\
     19     `FOLDER`   - optional, name or number of the folder; if none if supplied, the current folder will be used\\
    2120
    22 '''RETURNS'''
    23      VAR            - filename returned, with path\\
    24      <STEM>FILENAME - filename returned, with path\\
     21 RETURNS::
     22     `VAR`            - filename returned, with path\\
     23     `<STEM>FILENAME` - filename returned, with path\\
    2524
    26      RC is set to 10 if the specified folder doesn't exist or a group
     25     `RC` is set to 10 if the specified folder doesn't exist or a group
    2726     is currently selected.
    2827
    29 '''NOTES'''
    30      The command works by trying to lock the first message slot usable for
    31      the current date (e.g. Work:YAM/folder_name/09097.001 for Nov 28, 2002)
    32      and then working from there until the lock fails.
     28 NOTES::
    3329
    34 '''EXAMPLE'''
     30 EXAMPLE::
    3531
    36 '''BUGS'''
     32 BUGS::
    3733
    38 '''SEE ALSO'''
     34 SEE ALSO::