Changes between Version 4 and Version 5 of Documentation/ARexxAPI/REQUESTFILE


Ignore:
Timestamp:
Feb 5, 2014 11:11:28 AM (9 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUESTFILE

    v4 v5  
    11[[TranslatedPages]]\\ 
    22[[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]] 
    3  
    43== REQUESTFILE 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     RequestFile -- Request the user to select a file.  (V2.6) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,TITLE/A,DRAWER,FILE,MULTISELECT/S,DRAWERSONLY/S,SAVEMODE/S,NOICONS/S 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Requests the user to select a file. 
    1413 
    15 '''INPUTS''' 
    16      VAR/K             - alternative variable to put the results into instead of RESULT\\ 
    17      STEM/K            - base name used for the stem where the result will be stored\\ 
    18      TITLE/A           - the title of the file requester\\ 
    19      DRAWER            - initial drawer when opening the requester\\ 
    20      FILE              - initial file when opening the requester\\ 
    21      MULTISELECT/S     - enable multiselection\\ 
    22      DRAWERSONLY/S     - exclude files from selection\\ 
    23      SAVEMODE/S        - set requester to "save mode", no selection via doubleclick will be possible then\\ 
    24      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\\ 
    2524 
    26 '''RETURNS''' 
    27      VAR          - info returned by the query\\ 
    28      <STEM>DRAWER - name of the selected drawer\\ 
    29      <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\\ 
    3029 
    31      RC is set to 1 if the user cancels the requester. 
     30     `RC` is set to 1 if the user cancels the requester. 
    3231 
    33 '''NOTES''' 
     32 NOTES:: 
    3433 
    35 '''EXAMPLE''' 
    36          /* Enable result codes */\\ 
    37          OPTIONS RESULTS 
     34 EXAMPLE:: 
     35     {{{#!urbiscript 
     36     /* Enable result codes */ 
     37     OPTIONS RESULTS 
    3838 
    39          REQUESTFILE title="Please select a file" drawer="RAM:" STEM files. 
     39     REQUESTFILE title="Please select a file" drawer="RAM:" STEM files. 
    4040 
    41          IF RC~= 0 THEN EXIT 
     41     IF RC~= 0 THEN EXIT 
    4242 
    43          SAY "selected drawer is '" files.drawer "'"\\ 
    44          DO i=0 to files.COUNT-1\\ 
    45            SAY "selected file '" files.files.i "'"\\ 
    46          END\\ 
     43     SAY "selected drawer is '" files.drawer "'" 
     44     DO i=0 to files.COUNT-1 
     45       SAY "selected file '" files.files.i "'" 
     46     END 
     47     }}} 
    4748 
    48 '''BUGS''' 
     49 BUGS:: 
    4950 
    50 '''SEE ALSO''' 
     51 SEE ALSO::