ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Multi Page Image Functions / IG_mpi_delete
In This Topic
    IG_mpi_delete
    In This Topic

    This function calls IG_image_delete() for all valid pages of a multi-page image and frees all resources allocated with multi-page image handle.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI  IG_mpi_delete( HMIGEAR hMIGear );
    

    Arguments:

    Name Type Description
    hMIGear HMIGEAR Handle to 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++.

    Sample:

    MFC Multipage

    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_delete( hMIGear );
    

    Remarks:

    If it is associated with external file then it is closed with IG_mpi_close() before deletion.