read_charread_charReadCharread_charReadCharReadChar (Operator)

Name

read_charread_charReadCharread_charReadCharReadChar — Read a character from a text window.

Signature

Description

read_charread_charReadCharread_charReadCharReadChar reads a character from the keyboard in the input window (= output window). If the character is printable it is returned in CharCharCharCharCharcharVal. If a control key has been pressed, this will be indicated by the value of CodeCodeCodeCodeCodecode. 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.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontSetFontset_fontSetFontSetFont

Alternatives

read_stringread_stringReadStringread_stringReadStringReadString, fread_charfread_charFreadCharfread_charFreadCharFreadChar, fread_stringfread_stringFreadStringfread_stringFreadStringFreadString

See also

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, set_fontset_fontSetFontset_fontSetFontSetFont

Module

Foundation