wiki:Documentation/ARexxAPI/REQUESTSTRING

Version 1 (modified by AmigaPhil, 10 months ago) (diff)

--

REQUESTSTRING

NAME

RequestString -- Open a requester asking the user to enter a text string. (V2.0)

TEMPLATE

VAR/K,STEM/K,BODY/A,STRING/K,SECRET/S

FUNCTION

Opens a requester asking the user to enter a text string.

INPUTS

VAR/K - alternative variable to put the results into instead of RESULT
STEM/K - base name used for the stem where the result will be stored
BODY/A - a string containing the body of the requester
STRING/K - optional, text string used by default
SECRET/S - force characters to appear as asterisks ('*')

RETURNS

VAR - info returned by the query
<STEM>STRING - text entered in the requester

RC is set to 1 if the user cancels the requester.

NOTES

EXAMPLE

/* Enable result codes */

OPTIONS RESULTS

/* Request the user to type something */

body = '"Please type your name"'
default = '"Bill Clinton"'

REQUESTSTRING body STRING default

BUGS

SEE ALSO