L_TwainGetTransferOptions

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainGetTransferOptions(hSession, pTransferOpts, uStructSize)

HTWAINSESSION hSession;

/* handle to an existing TWAIN session */

pTRANSFEROPTIONS pTransferOpts;

/* pointer to a structure */

L_UINT uStructSize;

/* size of the TRANSFEROPTIONS structure */

Gets current transfer options for the selected Twain source.

Parameter

Description

hSession

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

pTransferOpts

Pointer to the TRANSFEROPTIONS structure to be updated with the current transfer options.

uStructSize

Size in bytes, of the structure pointed to by pTransferOpts, for versioning. Use sizeof(TRANSFEROPTIONS).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To set transfer options for the selected Twain driver, call the L_TwainSetTransferOptions function.

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_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_TwainShowProgress, L_TwainEnableDuplex, L_TwainGetDuplexOptions, L_TwainSetMaxXferCount, L_TwainGetMaxXferCount

Topics:

Getting and Setting Capabilities

 

TWAIN Functionality: Capability Functions

Example

For an example, refer to L_TwainSetTransferOptions.