read_string — Read a string in a text window.
read_string reads a string with a predetermined maximum size (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 size 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.
If the global variable 'filename_encoding' has been set to 'utf8' with set_system, read_string expects InString to be UTF-8 encoded and returns OutString UTF-8 encoded.
Default string (visible before input).
Default value: ''
Maximum number of characters.
Default value: 32
Restriction: 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.
read_char, fread_string, fread_char
set_tposition, new_line, open_window, set_font, set_color