ImageGear for C and C++ on Windows v19.5 - Updated
IG_TWAIN_file_get_image
API Reference Guide > TWAIN Component API Reference > TWAIN Component Functions Reference > Device File System Functions > IG_TWAIN_file_get_image

This function retrieves the image to which the device's file system context currently points.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_TWAIN_file_get_image(
        LPHIGEAR lphIGear,
        LPFNIG_TWAIN_AFTER_AUDIO_SNIPPET lpfnAfterSnippet,
        LPVOID lpAfterSnippetData,
        AT_MODE nFlags
);

Arguments:

Name Type Description
lphIGear LPHIGEAR Far pointer to HIGEAR object in which to return ImageGear handle of the acquired image.
lpfnAfterSnippet LPFNIG_TWAIN_AFTER_AUDIO_SNIPPET Far pointer to a callback function that will be called after each audio snippet is acquired.
lpAfterSnippetData LPVOID Optional pointer from which to pass and receive data. Set to NULL if you don't need to do this.
nFlags AT_MODE

Specifies the type of data to transfer. Can be one of the following values:

  • IG_TW_IMAGE - transfer the current image.
  • IG_TW_AUDIO - transfer the audio snippets associated with the current 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:

Depends on the scanner driver.

Remarks:

Use IG_TWAIN_file_get_first() and IG_TWAIN_file_get_next() to select the file you want to transfer from the device's file system.