get_figure_handle

Arguments

figure_id

Integer, id of the figure to retrieve.

f

Handle of the corresponding figure.

Description

This function is obsolete and will be removed in Scilab 6.1.x. Please use findobj("figure_id",n) instead.

get_figure_handle function allows to retrieve the handle of a graphic figure knowing its id. If a figure with the specified id exists the function returns it. Otherwise is returns an empty matrix.

Examples

// create some figures
scf(0);
scf(5);
scf(12);

// get handle on the figure with id 5
f5 = get_figure_handle(5);
// current figure remains the one with id 12
gcf()

// get a non existing figure
f42 = get_figure_handle(42);

See also

• set — set properties of some graphic objects or uimenus or uicontrol interactive components
• get — Retrieve a property value from a graphics entity or an User Interface object.
• gcf — Return handle of current graphic window.
• scf — set the current graphic figure (window)
• graphics_entities — description of the graphics entities data structures

History