LTwain::AcquireList

Summary

Acquires one or more pages from a TWAIN source and stores the images in the specified bitmap list.

Syntax

#include "ltwrappr.h"

virtual L_INT LTwain::AcquireList (hBitmap, lpszTemplateFile, uFlags)

virtual L_INT LTwain::AcquireList (BitmapList, lpszTemplateFile, uFlags)

Parameters

HBITMAPLIST hBitmap

Handle to the list of bitmaps acquired from the selected TWAIN source.

LBitmapList * BitmapList

Pointer to an LBitmapList object that references the list of bitmaps acquired from the selected TWAIN source.

L_TCHAR * lpszTemplateFile

Character string that contains the name of the template file in which the TWAIN source capability settings will be saved. If this parameter is NULL, the TWAIN capability settings used will not be saved to a template file. For more information on determining/setting the capabilities for a TWAIN source, refer to Getting and Settings Capabilities.

L_UINT uFlags

Flags that indicate whether to display the manufacturer's user interface. Possible values are:

Value Meaning
LTWAIN_ SHOW_ USER_ INTERFACE [0x0001] Shows the manufacturer's user interface as modeless.
LTWAIN_ MODAL_ USER_ INTERFACE [0x0002] Shows the manufacturer's user interface as a modal dialog. Works only if the LTWAIN_ SHOW_ USER_ INTERFACE flag is set.
LTWAIN_ KEEPOPEN [0x0020] Keep the TWAIN data source open after scanning.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function acquires one or more images from a TWAIN source and stores them in the specified bitmap list. To acquire one or more images and process each one individually, use the LTwain::Acquire function and provide an LTwain::BitmapCallBack function for processing each image.

The number of pages to acquire can be determined by getting the TWAIN source's capabilities. To change the number of pages to acquire, set the appropriate capability to the desired number.

The LTWAIN_ KEEPOPEN flag works only in the following cases:

  1. Passed with LTWAIN_SHOW_USER_INTERFACE flag to make TWAIN user-interface appears as modeless dialog. The TWAIN data source remains open after scanning until the user closes it.
  2. Passed with LTWAIN_SHOW_USER_INTERFACE and LTWAIN_MODAL_USER_INTERFACE flags to make the TWAIN user-interface appears as modal dialog. The TWAIN data source remains open after scanning until the user closes it.

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to LTwain::IsAvailable.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS TWAIN C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.