ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / TWAIN Component API Reference / TWAIN Component Functions Reference / Device File System Functions / IG_TWAIN_file_get_first
In This Topic
    IG_TWAIN_file_get_first
    In This Topic

    This function gets the first filename in a directory and returns information about that file (the same information that can be retrieved with IG_TWAIN_file_info_get()).

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_TWAIN_file_get_first(
            LPAT_TWAIN_FILEINFO lpFileInfo
    );
    

    Arguments:

    Name Type Description
    lpFileInfo LPAT_TWAIN_FILEINFO Pointer to an AT_TWAIN_FILEINFO structure that receives information about the first file in a directory.

    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 Data Source positions the file system context to point to the first filename. lpFileInfo->szName contains the absolute path and name of the file. If the Application calls IG_TWAIN_file_get_image(), the current image will be transferred. Applications must not assume any ordering of the files delivered by the Data Source, with one exception: if IG_TWAIN_file_get_first() is called in the root directory, the operation must return an IG_TW_FY_CAMERA device.

    Use IG_TWAIN_source_open() to select the desired Data Source.