get_iconT_get_iconGetIconGetIconget_icon (Operator)

Name

get_iconT_get_iconGetIconGetIconget_icon — Query the icon for region output

Signature

get_icon( : Icon : WindowHandle : )

Description

get_iconget_iconGetIconGetIconget_icon queries the icon that was set with set_iconset_iconSetIconSetIconset_icon.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

IconIconIconiconicon (output_object) region → object

Icon for the regions center of gravity.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

Example (C)

/* draw a region and an icon.  */
/* set it and get it again.    */
T_draw_region(&Region,WindowHandle);
T_draw_region(&Icon,WindowHandle);
set_icon(Icon);
create_tuple_s(&icon,"icon");
T_set_shape(WindowHandle,icon);
destroy_tuple(icon);
T_disp_region(Region,WindowHandle);
get_icon(&OldIcon);
T_disp_region(OldIcon,WindowHandle);

Result

get_iconget_iconGetIconGetIconget_icon always returns 2 ( H_MSG_TRUE) .

Possible Predecessors

set_iconset_iconSetIconSetIconset_icon

Possible Successors

disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

Operators