wiki:Documentation/ARexxAPI/SETFLAG

Version 3 (modified by AmigaPhil, 12 months ago) (diff)

--

Languages:


ARexx API

    SETFLAG

    NAME

    SetFlag -- Set the PERmanent and VOLatile flags of the currently selected message. (V2.0)

    TEMPLATE

    VOL/K/N,PER/K/N

    FUNCTION

    Sets the PERmanent and VOLatile flags of the currently selected message. These flags aren't used internally, but may come in handy in complex ARexx scripts.

    The value of the permanent flag is stored in the message file comment to ensure it will survive a restart or index rescan. The value of the volatile flag is lost when any of these events happens.

    INPUTS

    VOL/K/N - value of the VOLatile flag, may be between 0 and 7
    PER/K/N - value of the PERmanent flag, may be between 0 and 7

    RETURNS

    RC is set to 10 if the supplied value is out of the acceptable range.

    NOTES

    EXAMPLE

    /* Set the permanent flag */

    SETFLAG PER 5

    BUGS

    SEE ALSO

    MAILINFO ?