HALCON Reference Manual 10.0.2

write_stringwrite_stringwrite_stringWriteStringWriteString (Operator)

Name

write_stringwrite_stringwrite_stringWriteStringWriteString — Print text in a window.

Signature

write_string( : : WindowHandle, String : )

write_stringwrite_stringwrite_stringWriteStringWriteString prints StringStringStringStringstringVal in the output window starting at the current cursor position. The output text has to fit within the right window boundary (the width of the string can be queried by get_string_extentsget_string_extentsget_string_extentsGetStringExtentsGetStringExtents).

The font currently assigned to the window will used. The text cursor is positioned at the end of the text.

write_stringwrite_stringwrite_stringWriteStringWriteString can output all three types of data used in HALCON . The conversion to a string is guided by the following rules:

strings are not converted.

integer numbers are converted without any spaces before or after the number.

floating numbers are printed (if possible) with a floating point and without an exponent.

the resulting strings are concatenated without spaces.

For buffering of texts see set_systemset_systemset_systemSetSystemSetSystem with the flag 'flush_graphic'.

Attention

If clipping at the window boundary is desired, exceptions can be switched off by set_check('~text').

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window identifier.

StringStringStringStringstringVal (input_control) string(-array) → (string / integer / real)

Tuple of output values (all types).

Default value: 'hello' "hello" "hello" "hello" "hello"

Result

write_stringwrite_stringwrite_stringWriteStringWriteString returns 2 (H_MSG_TRUE) if the window is valid and the output text fits within the current line (see set_checkset_checkset_checkSetCheckSetCheck). Otherwise an exception is raised.