dev_inspect_ctrldev_inspect_ctrlDevInspectCtrlDevInspectCtrl (Operator)

Name

dev_inspect_ctrldev_inspect_ctrlDevInspectCtrlDevInspectCtrl — Open a window to inspect one or more control variables.

dev_inspect_ctrldev_inspect_ctrlDevInspectCtrlDevInspectCtrlDevInspectCtrl opens a variable inspect dialog to display the contents of one or more control variables. The result of this action is identical to selecting Inspect from the context menu of control variables in the variable window.

The standard variable inspection window displays the values in a table with some optional statistics. For some semantic types, e.g. matrices, a special representation exists and is used by default. For more information, see the chapter "Inspecting Variables" in the HDevelop User's Guide.

You can pass a tuple of variables in VariableVariableVariableVariablevariable to open an inspection window for multiple variables. It is also possible to override the default inspection mode by including a string literal as the first element of the tuple:

'tuple':

Show the values in the default inspection window even if the semantic type of the variable has a special representation.

'plot':

Plot the values of numeric variables against their tuple index.

'plot_xy':

Plot the values of numeric variables as X-Y pairs. The number of variables must be even, with each pair of variables having the same length.

Normally, the contents of the dialog will be updated whenever the variables change. However, the update behavior can be influenced by the operator dev_update_vardev_update_varDevUpdateVarDevUpdateVarDevUpdateVar and the Update Variable preference.

The dialog can be closed by pressing the Close button or by calling dev_close_inspect_ctrldev_close_inspect_ctrlDevCloseInspectCtrlDevCloseInspectCtrlDevCloseInspectCtrl.

Attention

This operator is not supported for code export.

Parameters

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

Name of the variable to be checked.

Example (HDevelop)

read_image (Image, 'fabrik')
regiongrowing (Image, Regions, 3, 3, 6, 100)
area_center (Regions, Area, Row, Column)
dev_inspect_ctrl (Area)
dev_inspect_ctrl (['plot_xy', Row, Column])

Result

If the values of the specified parameters are correct, dev_inspect_ctrldev_inspect_ctrlDevInspectCtrlDevInspectCtrlDevInspectCtrl returns 2 (H_MSG_TRUE). Otherwise an exception is raised and an error code returned.

Module

Foundation