L_TwainShowProgress

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainShowProgress(hSession, bShow)

HTWAINSESSION hSession;

/* handle to an existing TWAIN session */

L_BOOL bShow;

/* flag */

Enables or disables the display of a progress indicator during the acquisition of images from the current TWAIN source.

Parameter

Description

hSession

Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession function.

bShow

Flag that indicates whether to display a progress indicator during image acquisition from the current TWAIN source. Possible values are:

 

Value

Meaning

 

TRUE

Displays progress indicator during image acquisition.

 

FALSE

Hides the progress indicator during image acquisition

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function should be called after calling the L_TwainStartCapsNeg function and before calling the L_TwainEndCapsNeg function.

Required DLLs and Libraries

LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_TwainSetTransferOptions, L_TwainGetTransferOptions, L_TwainGetSupportedTransferMode, L_TwainSetResolution, L_TwainGetResolution, L_TwainSetImageFrame, L_TwainGetImageFrame, L_TwainSetImageUnit, L_TwainGetImageUnit, L_TwainSetImageBitsPerPixel, L_TwainGetImageBitsPerPixel, L_TwainSetImageEffects, L_TwainGetImageEffects, L_TwainSetAcquirePageOptions, L_TwainGetAcquirePageOptions, L_TwainSetRGBResponse, L_TwainEnableDuplex, L_TwainGetDuplexOptions, L_TwainSetMaxXferCount, L_TwainGetMaxXferCount

Topics:

Getting and Setting Capabilities

 

TWAIN Functionality: Capability Functions

Example

L_INT  TwainShowProgressExample(HTWAINSESSION hSession) 
{
   L_INT nRet;
   nRet = L_TwainStartCapsNeg (hSession);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_TwainShowProgress(hSession, TRUE);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_TwainEndCapsNeg (hSession);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}