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

    This function sets the image layout of the selected TWAIN device.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_TWAIN_image_layout_set(
         LPAT_DRECT rcdImgRect
    );
    

    Arguments:

    Name Type Description
    rcdImgRect LPAT_DRECT Pointer to an AT_DRECT representing the physical bounding box of the region to be acquired.

    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:

    You can use this to limit your capture region to a portion of the device's total area. The units are in inches by default. You can set the IG_TW_ICAP_UNITS capability to choose different units.

    Use IG_TWAIN_source_open() to select the desired Data Source prior to calling this function.