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


Ignore:
Timestamp:
Sep 23, 2013 9:12:00 PM (11 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/SETFOLDER

    v1 v1  
     1== SETFOLDER 
     2 
     3'''NAME''' 
     4     SetFolder -- Set the current folder. 
     5 
     6'''TEMPLATE''' 
     7     FOLDER/A 
     8 
     9'''FUNCTION''' 
     10     Makes the named folder the current folder. 
     11 
     12'''INPUTS''' 
     13     FOLDER/A   - name, directory or number of the folder to turn into the current folder; folder numbers start counting from 0 
     14 
     15'''RETURNS''' 
     16     RC is set to 10 if the specified folder doesn't exist. 
     17 
     18'''NOTES''' 
     19     In YAM 1.0 - 1.3.2, SETFOLDER could only accept a folder number 
     20     as argument.  This was changed in 1.3.3 to also accept folder names, 
     21     and again in 2.2 to accept directory names, too.  Therefore, to be 
     22     on the safe side scripts should check the YAM version in use before 
     23     deciding to use the latter as argument. 
     24 
     25     Also, bear in mind localization when referring to folders by their 
     26     name. 
     27 
     28'''EXAMPLE''' 
     29         /* Switch to the Outgoing folder */ 
     30 
     31         SETFOLDER Outgoing 
     32 
     33         /* Switch to the first folder in the list */ 
     34 
     35         SETFOLDER 0 
     36 
     37'''BUGS''' 
     38 
     39'''SEE ALSO''' 
     40     [[rx_requestfolder| REQUESTFOLDER ]]