ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / PDF Component API Reference / PDF Component Objects Reference / Basic Objects / HIG_PDF_BASARR / IG_PDF_basarr_remove_nth
In This Topic
    IG_PDF_basarr_remove_nth
    In This Topic

    Checks whether the position is within the array bounds, then removes it from the array, moves each subsequent element to the slot with the next smaller index, and decrements the array's length by 1.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_PDF_basarr_remove_nth(
            HIG_PDF_BASOBJ hArray,
            UINT nIndex
    );
    

    Arguments:

    Name Type Description
    hArray HIG_PDF_BASOBJ The array from which to remove the member.
    nIndex UINT The index for the array member to remove. Array indices start at 0.

    Return Value:

    Error count.

    Supported Raster Image Formats:

    This function does not process image pixels.