Shell Commands/RequestString

RequestString - Asks for a string via a requester

TITLE/A,BODY/A,POSITIVE/K,NEGATIVE/K,DEFSTRING/K,MAXLEN/K/N,NOTEMPTY/S,INVISIBLE/S, TO/K,PUBSCREEN/K,CHARSET/K,INACTIVE/S

TITLE     - Window title string of the requester
BODY      - Body string of the requester, *N does a line feed
POSITIVE  - Specifies the text to appear in the positive (left) choice
            of the requester, an underscore defines a shortcut key
NEGATIVE  - Specifies the text to appear in the negative (right) choice
            of the requester, an underscore defines a shortcut key
DEFSTRING - Specifies the default text for the string gadget
MAXLEN    - Sets the maximum length of the string
NOTEMPTY  - Do not accept an empty string
INVISIBLE - Entered characters are shown as asterisks, useful for
            password requesters
TO        - Specifies a file to write the result string into
PUBSCREEN - Opens the requester window on the specified pubscreen
CHARSET   - Specifies the character set used in BODY, POSITIVE, NEGATIVE,
            and DEFSTRING arguments
INACTIVE  - The requester window is not activated when opened

The result string is returned on the default output, enclosed in double quotation marks and terminated with a line feed. The quotation marks and the line feed are omitted when using the TO argument. The default text is returned if the requester is cancelled.

The command generates a return code of 0 if a string is returned, 5 if the requester was cancelled, and 20 in failures.

Example:

RequestString TITLE="My Requester" BODY="Please type*Nsome text."