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


Ignore:
Timestamp:
Sep 23, 2013, 9:10:05 PM (14 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/SETFLAG

    v1 v1  
     1== SETFLAG
     2
     3'''NAME'''
     4     SetFlag -- Set the PERmanent and VOLatile flags of the currently selected message.  (V2.0)
     5
     6'''TEMPLATE'''
     7     VOL/K/N,PER/K/N
     8
     9'''FUNCTION'''
     10     Sets the PERmanent and VOLatile flags of the currently selected
     11     message.  These flags aren't used internally, but may come in handy
     12     in complex ARexx scripts.
     13
     14     The value of the permanent flag is stored in the message file
     15     comment to ensure it will survive a restart or index rescan.
     16     The value of the volatile flag is lost when any of these events
     17     happens.
     18
     19'''INPUTS'''
     20     VOL/K/N   - value of the VOLatile flag, may be between 0 and 7\\
     21     PER/K/N   - value of the PERmanent flag, may be between 0 and 7\\
     22
     23'''RETURNS'''
     24     RC is set to 10 if the supplied value is out of the acceptable
     25     range.
     26
     27'''NOTES'''
     28
     29'''EXAMPLE'''
     30         /* Set the permanent flag */
     31
     32         SETFLAG PER 5
     33
     34'''BUGS'''
     35
     36'''SEE ALSO'''
     37     [[rx_mailinfo| MAILINFO ]]