int IMAPI ImgUnload (hImage, bDIB, bDDB, bWMF)

This function causes one or all of the given image's internal image representations (i.e., DIB, Device Dependent Bitmap, or Metafile) to be unloaded from memory.

 

Parameter	Type	Description
hImage	HANDLE	Identifies the image to be unloaded.
bDIB	BOOL	True if the DIB portion of the image should be unloaded.
bDDB	BOOL	True if the Device Dependent Bitmap portion of the image should be unloaded.
bWMF	BOOL	True if the Windows Metafile portion of the image should be unloaded.

 

Return Value

The return value is IMG_OK on success, an error value otherwise.

Comments

This function is useful for conserving memory. Note that even if the internal image is unloaded, the image information returned from ImgGetInfo remains consistent. Note also that no single image could have both a Metafile and a DIB loaded simultaneously vector images will load a Metafile, raster images will load a DIB.

 

If the ImgLoad function is used to load a portion of the image, subsequent calls to ImgGetInfo will reflect the image's "new" dimensions, i.e., the dimensions specified to load the image portion. The original image, and it's original dimensions, cannot be accessed unless ImgUnload is called, followed by an ImgLoad.

Note

This function does nothing to memory-based images, and will simply return IMG_OK.

 

 

---

© 1995-2004 Data Techniques, Inc. All rights reserved.