close (MATLAB Functions)

Delete specified figure

Syntax

close
close(h)
close name
close all
close all hidden
status = close(...)

Description

close deletes the current figure or the specified figure(s). It optionally returns the status of the close operation.

close deletes the current figure (equivalent to close(gcf)).

close(h) deletes the figure identified by h. If h is a vector or matrix, close deletes all figures identified by h.

close name deletes the figure with the specified name.

close all deletes all figures whose handles are not hidden.

close all hidden deletes all figures including those with hidden handles.

status = close(...) returns 1 if the specified windows have been deleted and 0 otherwise.

Remarks

The close function works by evaluating the specified figure's CloseRequestFcn property with the statement

```
eval(get(h,'CloseRequestFcn'))
```

The default CloseRequestFcn, closereq, deletes the current figure using delete(get(0,'CurrentFigure')). If you specify multiple figure handles, close executes each figure's CloseRequestFcn in turn. If MATLAB encounters an error that terminates the execution of a CloseRequestFcn, the figure is not deleted. Note that using your computer's window manager (i.e., the Close menu item) also calls the figure's CloseRequestFcn.

If a figure's handle is hidden (i.e., the figure's HandleVisibility property is set to callback or off and the root ShowHiddenHandles property is set on), you must specify the hidden option when trying to access a figure using the all option.

To delete all figures unconditionally, use the statements

set(0,'ShowHiddenHandles','on')
delete(get(0,'Children'))

The delete function does not execute the figure's CloseRequestFcn; it simply deletes the specified figure.

The figure CloseRequestFcn allows you to either delay or abort the closing of a figure once the close function has been issued. For example, you can display a dialog box to see if the user really wants to delete the figure or save and clean up before closing.

See Also

delete, figure, gcf

The figure HandleVisibility property

The root ShowHiddenHandles property

Figure Windows for related functions

clock close (avifile)