void tsmFreeImage ( Image_t *image, int free_bitmap )

Frees an Image_t structure

Documentation

Frees an Image_t structure.

This function will free an Image_t structure, as might be returned by tsmReadImage. You have the choice of whether you wish to free the bitmap array of this structure. If you are completely finished with this structure, then you should set free_bitmap to TRUE. However, if you want to free the memory for the Image_t structure but you want the bitmap data to live on, then you should use a value of FALSE.

Returns:
Nothing
Parameters:
image - (Image_t *) = pointer to the Image_t structure to free
free_bitmap - (int) = if TRUE, then free image->bitmap.
Author:
Martin Reddy
Version:
9 March 1999
See Also:
tsmReadImage, tsmWriteImage

TSMAPI_RELEASE 2.1 - Release Date: 2001/01/10 19:01:12

Back to tsmApi Home Page