ImageGear for C and C++ on Linux v18.8 - Updated
IG_mpi_close
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Multi Page Image Functions > IG_mpi_close

If the multi-page image hMIGear was previously associated with an external image file using the function IG_mpi_file_open(), then this function closes the file and frees all corresponding resources; if the multi-page image is not associated with an external file, then this function does nothing.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_mpi_close( HMIGEAR hMIGear );

Arguments:

Name Type Description
hMIGear HMIGEAR The handle to the allocated multi-page image.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

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

Example:

 
Copy Code
HMIGEAR hMIGear;    /* handle to multi-page image */
AT_ERRCOUNT nErrCount = IGE_SUCCESS;  /* will hold returned error count */
nErrCount = IG_mpi_create( &hMIGear, 0 );
 ...
/* any operations with hMIGear */
nErrCount = IG_mpi_close( hMIGear );