HALCON Website / HALCON Operator Reference / Graphics / Text
ClassesClassesClassesClasses | | | | Operators

read_charread_charReadCharread_charReadCharReadChar (Operator)

Name

read_charread_charReadCharread_charReadCharReadChar — Read a character from a text window.

Signature

read_char( : : WindowHandle : Char, Code)

Herror read_char(const Hlong WindowHandle, char* Char, char* Code)

Herror T_read_char(const Htuple WindowHandle, Htuple* Char, Htuple* Code)

Herror read_char(const HTuple& WindowHandle, char* Char, char* Code)

HTuple HWindow::ReadChar(HTuple* Code) const

void ReadChar(const HTuple& WindowHandle, HTuple* Char, HTuple* Code)

HString HWindow::ReadChar(HString* Code) const

void HOperatorSetX.ReadChar(
[in] VARIANT WindowHandle, [out] VARIANT* Char, [out] VARIANT* Code)

BSTR HWindowX.ReadChar([out] BSTR* Code)

static void HOperatorSet.ReadChar(HTuple windowHandle, out HTuple charVal, out HTuple code)

string HWindow.ReadChar(out string code)

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

'cancelled':

read_charread_charReadCharread_charReadCharReadChar has been cancelled (Windows only)

Attention

The window has to be a text window.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window handle.

CharCharCharCharCharcharVal (output_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

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

CodeCodeCodeCodeCodecode (output_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Code for input character.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, 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

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 13.0.4 Copyright © 1996-2019 MVTec Software GmbH