read_string — Read a string in a text window.
This operator does not work in an HDevelop graphics window opened with
read_string reads a string with a predetermined maximum length
Length) from the keyboard in the input window (= output
window). The string is read from the current position of the text cursor
using the current font. The maximum length has to be small enough to keep the
string within the right window boundary. A default string which can be
edited or simply accepted by the user may be provided. After text input
the text cursor is positioned at the end of the edited string.
Commands for editing:
delete the character on the left side of the cursor and move the cursor to this position.
The length is stated as number of characters. If 'filename_encoding'
is set to 'locale' with
set_system, the length is stated in
number of bytes.
Default string (visible before input).
Default value: ''
Maximum number of characters.
Default value: 32
Length > 0 && Length <= 1024
read_string returns 2 (H_MSG_TRUE) if the text window is valid and a
string of maximal length fits within the right window boundary.
Otherwise an exception is raised.