mvm_gui_get_uiT_mvm_gui_get_uiMvmGuiGetUiMvmGuiGetUi (Operator)

Name

mvm_gui_get_uiT_mvm_gui_get_uiMvmGuiGetUiMvmGuiGetUi — Receive current data from the clients.

Signature

mvm_gui_get_ui( : : ServerHandle, ConnectionHandle : UiDict)

Herror T_mvm_gui_get_ui(const Htuple ServerHandle, const Htuple ConnectionHandle, Htuple* UiDict)

void MvmGuiGetUi(const HTuple& ServerHandle, const HTuple& ConnectionHandle, HTuple* UiDict)

static void HHdevguiServerExtpack.MvmGuiGetUi(HTuple serverHandle, HTuple connectionHandle, out HTuple uiDict)

Description

Receives current data from the clients. The specified clients are queried actively for all of their data (all elements with attribute 'data-bind'). The data of each client is represented as HALCON dictionary where each key corresponds to the data-bind ID.

The dictionary values depend on the UI element and should be intuitive for most UI elements. For buttons, a counter is being returned which is 0 if the button was not pressed and a positive integer counting the number of button presses since the last call to mvm_gui_get_uimvm_gui_get_uiMvmGuiGetUiMvmGuiGetUiMvmGuiGetUi.

Multiple connections can be specified as tuple. A ConnectionHandleConnectionHandleConnectionHandleConnectionHandleconnectionHandle with the value 'all'"all""all""all""all" means that the UI state is requested from all connected clients and is the default. A value of 'first'"first""first""first""first" addresses only the first connection. Additionally, an optional custom error handling can be specified in ConnectionHandleConnectionHandleConnectionHandleConnectionHandleconnectionHandle. For further explanations on connection handles and custom error handling, see the MachineVisionMakers / HDevGUI chapter documentation for this extension package.

Execution Information

Parameters

ServerHandleServerHandleServerHandleServerHandleserverHandle (input_control)  serial HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

GUI server handle

ConnectionHandleConnectionHandleConnectionHandleConnectionHandleconnectionHandle (input_control)  socket(-array) HTupleHTupleHtuple (handle / string) (IntPtr / IntPtr) (HHandle / HString) (handle / char*)

The UI connection handle

Default value: 'all' "all" "all" "all" "all"

List of values: 'ack_error_ignore'"ack_error_ignore""ack_error_ignore""ack_error_ignore""ack_error_ignore", 'ack_error_lowlevel'"ack_error_lowlevel""ack_error_lowlevel""ack_error_lowlevel""ack_error_lowlevel", 'ack_error_raise'"ack_error_raise""ack_error_raise""ack_error_raise""ack_error_raise", 'all'"all""all""all""all", 'connection_error_ignore'"connection_error_ignore""connection_error_ignore""connection_error_ignore""connection_error_ignore", 'connection_error_lowlevel'"connection_error_lowlevel""connection_error_lowlevel""connection_error_lowlevel""connection_error_lowlevel", 'connection_error_raise'"connection_error_raise""connection_error_raise""connection_error_raise""connection_error_raise", 'first'"first""first""first""first"

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

a value

Example (HDevelop)

while (true)
    mvm_gui_get_ui (ServerHandle, 'first', UiDict)
    Slider := UiDict.slider1
    * ...
    wait_seconds (0.020)
endwhile

See also

mvm_gui_try_get_messagemvm_gui_try_get_messageMvmGuiTryGetMessageMvmGuiTryGetMessageMvmGuiTryGetMessage

Module

Foundation