L_TwainGetImageFrame

Summary

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

Syntax

#include "lttwn.h"

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

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

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

See Also

Functions

Topics

Example

For an example, refer to L_TwainSetImageFrame.

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 API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.