write_stringT_write_stringWriteStringWriteString (Operator)


write_stringT_write_stringWriteStringWriteString — Print text in a window.


write_string( : : WindowHandle, String : )

Herror T_write_string(const Htuple WindowHandle, const Htuple String)

void WriteString(const HTuple& WindowHandle, const HTuple& String)

void HWindow::WriteString(const HTuple& String) const

void HWindow::WriteString(const HString& String) const

void HWindow::WriteString(const char* String) const

void HWindow::WriteString(const wchar_t* String) const   (Windows only)

static void HOperatorSet.WriteString(HTuple windowHandle, HTuple stringVal)

void HWindow.WriteString(HTuple stringVal)

void HWindow.WriteString(string stringVal)


write_stringwrite_stringWriteStringWriteStringWriteString 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_extentsGetStringExtentsGetStringExtentsGetStringExtents).

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

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

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


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

Execution Information


WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

StringStringStringStringstringVal (input_control)  string(-array) HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Tuple of output values (all types).

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


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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont, get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents



See also

set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents, set_fontset_fontSetFontSetFontSetFont, set_systemset_systemSetSystemSetSystemSetSystem, set_checkset_checkSetCheckSetCheckSetCheck