L_TwainGetImageFrame

Summary

Gets the current image frame used to transfer images from the current TWAIN source.

Syntax

L_LTTWN_API L_INT L_TwainGetImageFrame(hSession, pFrame)

Parameters

HTWAINSESSION hSession

Handle to an existing TWAIN session. This handle is obtained by calling L_TwainInitSession or L_TwainInitSession2.

pTW_FRAME pFrame

Pointer to a structure to be updated with the current image frame.

Returns

Comments

The image frame specifies the size and location of the image to acquire. To set the image frame for the current TWAIN source, call the L_TwainSetImageFrame 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_TwainGetTransferOptions
• L_TwainGetSupportedTransferMode
• L_TwainSetResolution
• L_TwainGetResolution
• L_TwainSetImageFrame
• 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
• L_TwainFix32ToFloat

Topics

• Getting and Setting Capabilities
• TWAIN Functionality: Capability Functions

Example

For an example, refer to L_TwainSetImageFrame.