ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / TWAIN Component API Reference / TWAIN Component Functions Reference / Scanning Functions / IG_TWAIN_acquire
In This Topic
    IG_TWAIN_acquire
    In This Topic

    This function acquires a single image from the selected TWAIN device.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_TWAIN_acquire(
            LPHIGEAR lphIGear,
            AT_BOOL bShowUI
    );
    

    Arguments:

    Name Type Description
    lphIGear LPHIGEAR Far pointer to HIGEAR object in which to return ImageGear handle of the acquired image.
    bShowUI AT_BOOL This flag determines whether or not the user interface is shown. Set to TRUE if you want ImageGear to obtain the capability settings from the end-user.

    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:

    Depends on the scanner driver.

    Remarks:

    A DIB will be built to hold the acquired image, and its ImageGear handle will be returned through the lphIGear argument.

    Use IG_TWAIN_source_open() to select the desired Data Source, and IG_TWAIN_cap_set() to set desired capabilities values, prior to calling this function.