read_charT_read_charReadCharReadCharread_char (Operator)

Name

read_charT_read_charReadCharReadCharread_char — Read a character from a window.

Signature

read_char( : : WindowHandle : Char, Code)

Description

read_charread_charReadCharReadCharReadCharread_char reads a character from the keyboard in the input window (= output window). If the character is printable it is returned in CharCharCharCharcharValchar. 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
'canceled':: read_charread_charReadCharReadCharReadCharread_char has been canceled (Windows only)

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

CharCharCharCharcharValchar (output_control) string → (string)

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

CodeCodeCodeCodecodecode (output_control) string → (string)

Code for input character.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, set_fontset_fontSetFontSetFontSetFontset_font

Alternatives

read_stringread_stringReadStringReadStringReadStringread_string, fread_charfread_charFreadCharFreadCharFreadCharfread_char, fread_stringfread_stringFreadStringFreadStringFreadStringfread_string

Module

Foundation

Operators