ClassesClassesClassesClasses | | | | Operators

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString (Operator)

Name

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString — Print text in a window.

Signature

write_string( : : WindowHandle, String : )

Herror write_string(const Hlong WindowHandle, const char* String)

Herror T_write_string(const Htuple WindowHandle, const Htuple String)

Herror write_string(const HTuple& WindowHandle, const HTuple& String)

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

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 HOperatorSetX.WriteString(
[in] VARIANT WindowHandle, [in] VARIANT String)

void HWindowX.WriteString([in] VARIANT String)

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

void HWindow.WriteString(HTuple stringVal)

void HWindow.WriteString(string stringVal)

Description

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString prints StringStringStringStringStringstringVal 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_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents).

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

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString 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_systemSetSystemset_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

Parameters

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

Window identifier.

StringStringStringStringStringstringVal (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

Tuple of output values (all types).

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

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontSetFontset_fontSetFontSetFont, get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents

Alternatives

fwrite_stringfwrite_stringFwriteStringfwrite_stringFwriteStringFwriteString

See also

set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontSetFontset_fontSetFontSetFont, set_systemset_systemSetSystemset_systemSetSystemSetSystem, set_checkset_checkSetCheckset_checkSetCheckSetCheck

Module

Foundation


ClassesClassesClassesClasses | | | | Operators