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


Ignore:
Timestamp:
Sep 23, 2013 9:04:15 PM (10 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/REQUESTSTRING

    v1 v1  
     1== REQUESTSTRING 
     2 
     3'''NAME''' 
     4     RequestString -- Open a requester asking the user to enter a text string.  (V2.0) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,BODY/A,STRING/K,SECRET/S 
     8 
     9'''FUNCTION''' 
     10     Opens a requester asking the user to enter a text string. 
     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     BODY/A     - a string containing the body of the requester\\ 
     16     STRING/K   - optional, text string used by default\\ 
     17     SECRET/S   - force characters to appear as asterisks ('*')\\ 
     18 
     19'''RETURNS''' 
     20     VAR          - info returned by the query\\ 
     21     <STEM>STRING - text entered in the requester\\ 
     22 
     23     RC is set to 1 if the user cancels the requester. 
     24 
     25'''NOTES''' 
     26 
     27'''EXAMPLE''' 
     28         /* Enable result codes */ 
     29 
     30         OPTIONS RESULTS 
     31 
     32         /* Request the user to type something */ 
     33 
     34         body = '"Please type your name"'\\ 
     35         default = '"Bill Clinton"'\\ 
     36 
     37         REQUESTSTRING body STRING default 
     38 
     39'''BUGS''' 
     40 
     41'''SEE ALSO'''