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


Ignore:
Timestamp:
Sep 23, 2013 8:59:12 PM (12 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUESTFILE

    v1 v1  
     1== REQUESTFILE 
     2 
     3'''NAME''' 
     4     RequestFile -- Request the user to select a file.  (V2.6) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,TITLE/A,DRAWER,FILE,MULTISELECT/S,DRAWERSONLY/S,SAVEMODE/S 
     8 
     9'''FUNCTION''' 
     10     Requests the user to select a file. 
     11 
     12'''INPUTS''' 
     13     VAR/K             - alternative variable to put the results into instead of RESULT\\ 
     14     STEM/K            - base name used for the stem where the result will be stored\\ 
     15     TITLE/A           - the title of the file requester\\ 
     16     DRAWER            - initial drawer when opening the requester\\ 
     17     FILE              - initial file when opening the requester\\ 
     18     MULTISELECT/S     - enable multiselection\\ 
     19     DRAWERSONLY/S     - exclude files from selection\\ 
     20     SAVEMODE/S        - set requester to "save mode", no selection via doubleclick will be possible then\\ 
     21 
     22'''RETURNS''' 
     23     VAR          - info returned by the query\\ 
     24     <STEM>DRAWER - name of the selected drawer\\ 
     25     <STEM>FILES  - names of the selected files\\ 
     26 
     27     RC is set to 1 if the user cancels the requester. 
     28 
     29'''NOTES''' 
     30 
     31'''EXAMPLE''' 
     32         /* Enable result codes */\\ 
     33         OPTIONS RESULTS 
     34 
     35         REQUESTFILE title="Please select a file" drawer="RAM:" STEM files. 
     36 
     37         IF RC~= 0 THEN EXIT 
     38 
     39         SAY "selected drawer is '" files.drawer "'"\\ 
     40         DO i=0 to files.COUNT-1\\ 
     41           SAY "selected file '" files.files.i "'"\\ 
     42         END\\ 
     43 
     44'''BUGS''' 
     45 
     46'''SEE ALSO'''