Changes between Version 3 and Version 8 of Documentation/ARexxAPI/REQUESTFILE


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUESTFILE

    v3 v8  
    11[[TranslatedPages]] 
    2  
     2[[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]] 
    33== REQUESTFILE 
    44 
    5 '''NAME''' 
     5 NAME:: 
    66     RequestFile -- Request the user to select a file.  (V2.6) 
    77 
    8 '''TEMPLATE''' 
     8 TEMPLATE:: 
    99     VAR/K,STEM/K,TITLE/A,DRAWER,FILE,MULTISELECT/S,DRAWERSONLY/S,SAVEMODE/S,NOICONS/S 
    1010 
    11 '''FUNCTION''' 
     11 FUNCTION:: 
    1212     Requests the user to select a file. 
    1313 
    14 '''INPUTS''' 
    15      VAR/K             - alternative variable to put the results into instead of RESULT\\ 
    16      STEM/K            - base name used for the stem where the result will be stored\\ 
    17      TITLE/A           - the title of the file requester\\ 
    18      DRAWER            - initial drawer when opening the requester\\ 
    19      FILE              - initial file when opening the requester\\ 
    20      MULTISELECT/S     - enable multiselection\\ 
    21      DRAWERSONLY/S     - exclude files from selection\\ 
    22      SAVEMODE/S        - set requester to "save mode", no selection via doubleclick will be possible then\\ 
    23      NOICONS/S         - hide icon files\\ 
     14 INPUTS:: 
     15     `VAR/K`             - alternative variable to put the results into instead of `RESULT`\\ 
     16     `STEM/K`            - base name used for the stem where the result will be stored\\ 
     17     `TITLE/A`           - the title of the file requester\\ 
     18     `DRAWER`            - initial drawer when opening the requester\\ 
     19     `FILE`              - initial file when opening the requester\\ 
     20     `MULTISELECT/S`     - enable multiselection\\ 
     21     `DRAWERSONLY/S`     - exclude files from selection\\ 
     22     `SAVEMODE/S`       - set requester to "save mode", no selection via doubleclick will be possible then\\ 
     23     `NOICONS/S`         - hide icon files\\ 
    2424 
    25 '''RETURNS''' 
    26      VAR          - info returned by the query\\ 
    27      <STEM>DRAWER - name of the selected drawer\\ 
    28      <STEM>FILES  - names of the selected files\\ 
     25 RETURNS:: 
     26     `VAR`          - info returned by the query\\ 
     27     `<STEM>DRAWER` - name of the selected drawer\\ 
     28     `<STEM>FILES`  - names of the selected files\\ 
    2929 
    30      RC is set to 1 if the user cancels the requester. 
     30     `RC` is set to 1 if the user cancels the requester. 
    3131 
    32 '''NOTES''' 
     32 NOTES:: 
    3333 
    34 '''EXAMPLE''' 
    35          /* Enable result codes */\\ 
    36          OPTIONS RESULTS 
     34 EXAMPLE:: 
     35     {{{#!arexx 
     36     /* Enable result codes */ 
     37     OPTIONS RESULTS 
    3738 
    38          REQUESTFILE title="Please select a file" drawer="RAM:" STEM files. 
     39     REQUESTFILE title="Please select a file" drawer="RAM:" STEM files. 
    3940 
    40          IF RC~= 0 THEN EXIT 
     41     /* Only continue if RC == 0 */ 
     42     IF RC ~= 0 THEN EXIT 
    4143 
    42          SAY "selected drawer is '" files.drawer "'"\\ 
    43          DO i=0 to files.COUNT-1\\ 
    44            SAY "selected file '" files.files.i "'"\\ 
    45          END\\ 
     44     SAY "selected drawer is '" files.drawer "'" 
     45     DO i=0 to files.COUNT-1 
     46       SAY "selected file '" files.files.i "'" 
     47     END 
     48     }}} 
    4649 
    47 '''BUGS''' 
     50 BUGS:: 
    4851 
    49 '''SEE ALSO''' 
     52 SEE ALSO::