IG_GUI_page

This function removes (deletes) the image referred to by nPage from the GUI Page Sorter.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_GUI_page_remove( HWND hwndPage, UINT nPage );

Arguments

Name	Type	Description
hwndPage	HWND	HIGEAR Windows handle to the GUI Page Sorter window.
nPage	UINT	Set to an UINT indicating the number of the page (thumbnail) in the GUI Page Sorter that you would like to delete.

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++.

Sample:

None

Example:

	Copy Code
HIGEAR hIGear; /* HIGEAR handle of image / HWND hwndPage; / Windows handle to the Page Sorter window / UINT nPage; / Page number of image to remove / AT_ERRCOUNT nErrcount; / Tally of ImageGear errors on the stack */ nErrcount = IG_GUI_page_remove(hwndPage, nPage);

Copy Code

HIGEAR hIGear;  /* HIGEAR handle of image  */
HWND hwndPage; /* Windows handle to the Page Sorter window */
UINT nPage;   /* Page number of image to remove */
AT_ERRCOUNT nErrcount; /* Tally of ImageGear errors on the stack   */
nErrcount = IG_GUI_page_remove(hwndPage, nPage);

Remarks:

The image file will be closed, and the pages will be re-numbered if necessary. For example, if you delete nPage = 2 from a GUI Page Sorter that contains 3 images, the image formerly referred to as Page 3 will be made Page 2. (All images will retain their original HIGEAR handles).

This function does not clear the image's handle from memory. You should call IG_image_delete() when the image is no longer needed.