ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / ISIS Component API Reference / ISIS Component Functions Reference / Custom Scanner Functions / IG_ISIS_selection_iterate_next
In This Topic
    IG_ISIS_selection_iterate_next
    In This Topic

    Obtain the next scanner information record in the iteration cycle started by IG_ISIS_selection_iterate_init.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_ISIS_selection_iterate_next(
            LPHISISSELITER lphIteration,
            LPAT_ISIS_DRIVERINFO lpDriverInfo
    );
    

    Arguments:

    Name Type Description
    lphIteration LPHISISSELITER Points to the driver iteration cycle as initialized by IG_ISIS_selection_iterate_init.
    lpDriverInfo LPAT_ISIS_DRIVERINFO Points to the next scanner information record obtained from the iteration cycle.

    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:

    This function does not process image pixels.

    Remarks:

    The IG_ISIS_selection_iterate_next function obtains the next record in the driver iteration cycle. It should be called repeatedly until all the records have been retrieved.

    The IG_ISIS_selection_iterate_init and IG_ISIS_selection_iterate_next functions go through the driver iteration cycle to obtain information on all scanner models supported by those drivers. Each AT_ISIS_DRIVERINFO structure returned in driverInfo contains the model name of the scanner, its associated driver, and a unique ID. Your application can then present a list of all the supported scanner models to the user. If you keep track of the association between the scanner name and its ID, you can then use the IG_ISIS_selection_get_driver_info function to retrieve the scanner information record after the user selects a scanner.

    You should call IG_ISIS_selection_iterate_next repeatedly until all the records have been found. Then call IG_ISIS_selection_iterate_done to release the memory allocated for the iteration cycle.

    See Also

    IG_ISIS_selection_iterate_init

    IG_ISIS_selection_iterate_done

    IG_ISIS_selection_get_driver_info