get_icon

get_icon ( : Icon : WindowHandle : )

Query the icon for region output

get_icon queries the icon that was set with set_icon.

Parameters

`Icon` (output_object)	region `->` object
Icon for the regions center of gravity.

`WindowHandle` (input_control)	window `->` integer
Window_id.

Example (Syntax: 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_icon always returns 2 (H_MSG_TRUE).

Parallelization Information

get_icon is reentrant and processed without parallelization.

Possible Predecessors

set_icon

Possible Successors

disp_region

Module

Foundation