ImageGear for C and C++ on Windows v19.7 - Updated
IG_image_is_valid
API Reference Guide > Core Component API Reference > Core Component Functions Reference > General Image Functions > IG_image_is_valid

This function is called to determine if the HIGEAR variable hIGear contains a handle of a valid ImageGear image.

Declaration:

 
Copy Code
BOOL ACCUAPI IG_image_is_valid (HIGEAR hIGear);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle of image.

Return Value:

This function returns TRUE if a hIGear contains a valid handle; FALSE otherwise.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

ASCII, Clipboard, Color, Display, GUI Windows, Image Processing, Image Util, IOSET, JPEG, Magnify, Medical, Memory IO, MFC, Page, Palette Edit, Panning, Pixel Access, Thumbnail, TWAIN, Wipes, MFC Threads, Annotation, GUI Scan, Vector, Filters, FlashPix, ImageClean, Multimedia

Example:

 
Copy Code
HIGEAR hIGear;     /* Contains HIGEAR handle of image   */
if ( IG_image_is_valid ( hIGear ) )
        { IG_save_file ( hIGear, "picture.bmp", IG_SAVE_BMP_UNCOMP ); }

Remarks:

Note that the return-type of the function is BOOL, not AT_ERRCOUNT. TRUE is returned if the handle is valid and may be used as the HIGEAR argument in calls to other ImageGear functions.