read_charT_read_charReadCharReadChar (Operator)

Name

read_charT_read_charReadCharReadChar — Read a character from a text window.

Signature

read_char( : : WindowHandle : Char, Code)

Description

read_charread_charReadCharReadCharReadChar reads a character from the keyboard in the input window (= output window). If the character is printable it is returned in CharCharCharCharcharVal. If a control key has been pressed, this will be indicated by the value of CodeCodeCodeCodecode. 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
'cancelled':: read_charread_charReadCharReadCharReadChar has been cancelled (Windows only)

Attention

The window has to be a text window.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

CharCharCharCharcharVal (output_control) string → (string)

Input character (if it is not a control character).

CodeCodeCodeCodecode (output_control) string → (string)

Code for input character.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont

Alternatives

read_stringread_stringReadStringReadStringReadString, fread_charfread_charFreadCharFreadCharFreadChar, fread_stringfread_stringFreadStringFreadStringFreadString

See also

write_stringwrite_stringWriteStringWriteStringWriteString, set_fontset_fontSetFontSetFontSetFont

Module

Foundation