get_iconget_iconGetIconGetIcon (Operator)

Name

get_iconget_iconGetIconGetIcon — Query the icon for region output

Signature

get_icon( : Icon : WindowHandle : )

Description

get_iconget_iconGetIconGetIconGetIcon queries the icon that was set with set_iconset_iconSetIconSetIconSetIcon.

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.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

Example (C)

/* draw a region and an icon.  */
/* set it and get it again. */
draw_region(&Region,WindowHandle) ;
draw_region(&Icon,WindowHandle) ;
set_icon(Icon) ;
set_shape(WindowHandle,"icon") ;
disp_region(Region,WindowHandle) ;
get_icon(&OldIcon) ;
disp_region(OldIcon,WindowHandle) ;

Result

get_iconget_iconGetIconGetIconGetIcon always returns 2 (H_MSG_TRUE).

Possible Predecessors

set_iconset_iconSetIconSetIconSetIcon

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation

Operators