Changes between Version 3 and Version 4 of Documentation/ARexxAPI/REQUESTSTRING


Ignore:
Timestamp:
Feb 5, 2014 12:03:29 PM (7 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUESTSTRING

    v3 v4  
    1 [[TranslatedPages]]\\ 
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]] 
    3  
     1[[TranslatedPages]] 
     2[[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]] 
    43== REQUESTSTRING 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     RequestString -- Open a requester asking the user to enter a text string.  (V2.0) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,BODY/A,STRING/K,SECRET/S 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Opens a requester asking the user to enter a text string. 
    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      BODY/A     - a string containing the body of the requester\\ 
    19      STRING/K   - optional, text string used by default\\ 
    20      SECRET/S   - force characters to appear as asterisks ('*')\\ 
     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     `BODY/A`     - a string containing the body of the requester\\ 
     18     `STRING/K`   - optional, text string used by default\\ 
     19     `SECRET/S`   - force characters to appear as asterisks ('*')\\ 
    2120 
    22 '''RETURNS''' 
    23      VAR          - info returned by the query\\ 
    24      <STEM>STRING - text entered in the requester\\ 
     21 RETURNS:: 
     22     `VAR`          - info returned by the query\\ 
     23     `<STEM>STRING` - text entered in the requester\\ 
    2524 
    26      RC is set to 1 if the user cancels the requester. 
     25     `RC` is set to 1 if the user cancels the requester. 
    2726 
    28 '''NOTES''' 
     27 NOTES:: 
    2928 
    30 '''EXAMPLE''' 
    31          /* Enable result codes */ 
     29 EXAMPLE:: 
     30     {{{#!urbiscript 
     31     /* Enable result codes */ 
     32     OPTIONS RESULTS 
    3233 
    33          OPTIONS RESULTS 
     34     /* Request the user to type something */ 
     35     body = '"Please type your name"' 
     36     default = '"Bill Clinton"' 
    3437 
    35          /* Request the user to type something */ 
     38     REQUESTSTRING body STRING default 
     39     }}} 
    3640 
    37          body = '"Please type your name"'\\ 
    38          default = '"Bill Clinton"'\\ 
     41 BUGS:: 
    3942 
    40          REQUESTSTRING body STRING default 
    41  
    42 '''BUGS''' 
    43  
    44 '''SEE ALSO''' 
     43 SEE ALSO::