LTwain::AcquireMulti

#include "ltwrappr.h"

virtual L_INT LTwain::AcquireMulti(pszBaseFileName, uFlags, uTransferMode, nFormat, nBitsPerPixel, bMultiPageFile, uUserBufSize, bUsePrefferedBuffer)

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

This function is available in the Document/Medical Toolkits.

Returns

Comments

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

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 LTwain::FindFastConfig to determine the best scan configuration and then pass the scan configuration information to the LTwain::AcquireMulti function. If you do not call LTwain::FindFastConfig before calling LTwain::AcquireMulti, then the LTwain::AcquireMulti 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", 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.

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 LTwain::CancelAcquire.

To stop acquire images only from the feeder of the TWAIN source, call the LTwain::StopFeeder within the LTwain::AcquireCallBack function when its fired.

You can achieve the same functionality to this function by using the LTwain::FastAcquire.

The LTWAIN_KEEPOPEN flag works only in the following cases:

Required DLLs and Libraries

See Also

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_VOID CMyTwain::AcquireCallBack(L_INT nPage, L_TCHAR* pszFileName, L_BOOL bFinishScan)
{
   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 LTwain__AcquireMultiExample(HWND hWnd, CMyTwain *MyClass)
{
   L_INT             nRet;
   L_BOOL            bAvailable;
   APPLICATIONDATA   AppData;
   /* Check to see if TWAIN is installed */
   bAvailable = MyClass->IsAvailable();
   if (bAvailable)
   {
      AppData.hWnd = hWnd; 
      AppData.uStructSize = sizeof(APPLICATIONDATA);
      lstrcpy (AppData.szManufacturerName, TEXT("LEAD Technologies, Inc.")); 
      lstrcpy (AppData.szAppProductFamily, TEXT("LEAD Test Applications"));
      lstrcpy (AppData.szVersionInfo, TEXT("Version 1.0"));
      lstrcpy (AppData.szAppName, TEXT("TWAIN Test Application"));
      nRet = MyClass->InitSession(&AppData); 
      if(nRet != SUCCESS)
         return nRet;
   }
   MyClass->EnableCallBack (TRUE);
   nRet = MyClass->AcquireMulti(
                              MAKE_IMAGE_PATH(TEXT("test.bmp")),
                              LTWAIN_SHOW_USER_INTERFACE,
                              LTWAIN_FILE_MODE,
                              FILE_BMP,
                              1,
                              TRUE,
                              0, 
                              TRUE);
   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;
}