ImageGear for C and C++ on Windows v19.1 - Updated
MED_ElemList_curr_remove
API Reference Guide > MD Component API Reference > MD Component Functions Reference > Data Set Element List Functions > MED_ElemList_curr_remove

This function removes the Current Data Element from the Element List.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI MED_ElemList_curr_remove (
        HIGMEDELEMLIST hIGMedElemList, 
        LPAT_BOOL lpRemoved
);

Arguments:

Name Type Description
hIGMedElemList HIGMEDELEMLIST HIGMEDELEMLIST handle to the Data Element List object.
lpRemoved LPAT_BOOL A far pointer to a BOOL which returns TRUE if the Current Data Element was removed; it will return FALSE if there are no more removable DEs in the Element List or if the Current Data Element could not be removed.

Return Value:

Returns the number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The new Current Data Element will be the Data Element following the one that was just removed, unless you have deleted the last DE, in which case the CDE will be the "new" last DE.

If the Element List is empty (there are no removable DEs remaining) lpRemoved will return FALSE. The critical DEs cannot be removed. Non-removable DEs also include Sequence and Item Delimiters.