read_char

read_char ( : : WindowHandle : Char, Code )

Read a character from a text window.

read_char reads a character from the keyboard in the input window (= output window). If the character is printable it is returned in Char. If a control key has been pressed, this will be indicated by the value of Code. Some important keys are recognizable by this value. Possible values are:

                   'character'   printable character
                   'left'        cursor left
                   'right'       cursor right
                   'up'          cursor up
                   'down'        cursor down
                   'insert'      insert
                   'none'        none of these keys

Attention

The window has to be a text window.

Parameters

`WindowHandle` (input_control)	window `->` integer
Window identifier.

`Char` (output_control)	string `->` string
Input character (if it is not a control character).

`Code` (output_control)	string `->` string
Code for input character.

Result

read_char returns 2 (H_MSG_TRUE) if the text window is valid. Otherwise an exception handling is raised.

Parallelization Information

read_char is reentrant, local, and processed without parallelization.

Possible Predecessors

open_textwindow, set_font

Alternatives

read_string, fread_char, fread_string

See also

write_string, set_font

Module

System