L_TwainAcquireMulti2

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainAcquireMulti2(hSession, pszBaseFileName, nStartPageNumber, uFlags, uTransferMode, nFormat, nBitsPerPixel, bMultiPageFile, uUserBufSize, bUsePrefferedBuffer, pfnCallBack, pUserData)

Acquires one or more images from a TWAIN source and stores the images in the specified file(s).

Returns

Comments

This function will acquire one or more images from a TWAIN source and store the images to the specified file(s).

This function was added in order to allow users to prevent already scanned files from being overwritten by a subsequent scan batch. To accomplish such goal, specify the page number where the new files creation should start numbering files. If for example,  three pages are scanned while the specified pszBaseFileName parameter is "BaseFileName.bmp", then the output files will have the names, "BaseFileName_0001.bmp", "BaseFileName_0002.bmp" and "BaseFileName_0003.bmp", etc. Starting a new scan while the nStartPageNumber is -1, then the saved files will be overwritten. In order to avoid that, pass 4 for the nStartPageNumber parameter so the new scanned files will start from 4. The file will save as "BaseFileName_0004.bmp", "BaseFileName_0005.bmp", ...etc.

Based on the scanner type, this function will determine the best/fastest scanning method to use. This method will be used when actually scanning the image(s). Before calling this function you can call L_TwainFindFastConfig to determine the best scan configuration and then pass the scan configuration information to the L_TwainAcquireMulti2 function. If you do not call L_TwainFindFastConfig before calling L_TwainAcquireMulti2, then the L_TwainAcquireMulti2 function will determine the best scanning method.

If the file format specified in nFormat does not support multi-page files, this function will ignore the bMultiPageFile parameter and automatically save the scanned images in separate files. The naming of the files will be carried out as follows: if the string in pszBaseFileName is "Temp.jpg", and the nStartPageNumber is -1, the method will append the number of the image, 0001, 0002, etc, to the name of the file. Therefore, the output file names will be "Temp0001.jpg", "Temp0002.jpg", etc. But if nStartPageNumber is not -1 (which should be any value bigger than zero), then the numbering will start from that value, so if for example the nStartPageNumber contains the value 4 then the output file names will be "Temp0004.jpg", "Temp0005.jpg", etc.

If the file format specified in nFormat supports multi-page files, this function will use the bMultiPageFile parameter to determine how to save multiple images. If bMultiPageFile is FALSE, each scanned page will be saved to a separate file, named in the same manner described in the paragraph above. If bMultiPageFile is TRUE, the name of the output file will be exactly the string in pszBaseFileName (Temp.jpg) and it will be saved as a multi-page file.

If uTransferMode is LTWAIN_BUFFER_MODE, and bUsePrefferedBuffer  is FALSE, then the function will use the user-defined buffer size in uUserBufSize. If however bUsePrefferedBuffer is TRUE, then the function will use the Twain driver preferred buffer size and will ignore uUserBufSize.

To cancel the acquire operation call the L_TwainCancelAcquire.

To stop acquire images only from the feeder of the TWAIN source, call the L_TwainStopFeeder function.

The LTWAIN_KEEPOPEN flag works only in the following cases:

Required DLLs and Libraries

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_VOID EXT_CALLBACK AcquireMultiCB(HTWAINSESSION hSession, 
L_INT         nPage, 
L_TCHAR*      pszFileName, 
L_BOOL        bFinishScan, 
L_VOID*       pUserData) 
{ 
   UNREFERENCED_PARAMETER(hSession); 
   UNREFERENCED_PARAMETER(pUserData); 
   L_TCHAR szTemp[MAX_PATH]; 
   if (bFinishScan) 
   { 
      wsprintf(szTemp, TEXT("The page # %d is scanned and saved to file name %s\n"), nPage, pszFileName); 
      MessageBox(NULL, szTemp, TEXT("Notice"), MB_OK); 
   } 
} 
L_INT TwainAcquireMulti2Example(HWND hWnd,HTWAINSESSION hSession) 
{ 
   L_INT nRet; 
   nRet = L_TwainAcquireMulti2(hSession, 
   MAKE_IMAGE_PATH(TEXT("test.tif")), 
   3, // start page number to use when numbering output file names, output files should be test_0003.tif, test_0004.tif, ...etc 
   LTWAIN_SHOW_USER_INTERFACE, 
   LTWAIN_BUFFER_MODE, 
   FILE_TIF, 
   1, 
   TRUE, 
   0, 
   FALSE, 
   AcquireMultiCB, NULL); 
   if (nRet == SUCCESS) 
      MessageBox(hWnd, TEXT("Fast Twain function was successful"), TEXT("Notice"), MB_OK); 
   else 
      MessageBox(hWnd, TEXT("Error occurred during fast Twain function!!!"), TEXT("Error!!!"), MB_OK); 
   return nRet; 
}