NAME

xil_destroy − destroy an image

SYNOPSIS

#include <xil/xil.h>

void xil_destroy ( XilImage image);

DESCRIPTION

This routine destroys an image, freeing the resources associated with the image structure.  It also deallocates the memory used to store image data if that memory was allocated by XIL.  If the image has child images allocated with it, they are also destroyed. 

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide. 

EXAMPLES

Destroy an image:

XilImage image;
xil_destroy (image);

NOTES

The user is responsible for freeing memory that has been assigned to an image via an xil_set_memory_storage(3) call. 

Referencing an image after it has been destroyed (including any children that have been automatically destroyed) is an error that may cause problems potentially severe enough to cause a core dump. 

If you create an XIL display image on an X display, you must destroy that image before calling XCloseDisplay(). Calling XCloseDisplay() before calling xil_destroy() will make xil_destroy() work improperly.

SEE ALSO

xil_create(3), xil_create_child(3), xil_create_from_type(3), xil_create_copy(3), xil_create_from_window(3), xil_create_from_device(3), xil_set_memory_storage(3). 

SunOS   —  Last change: 16 August 1993