L_TwainGetImageUnit

Summary

Gets the current image unit value used when transferring images from the current TWAIN source.

Syntax

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainGetImageUnit (hSession, pnUnit)

Parameters

HTWAINSESSION hSession

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

L_INT * pnUnit

Pointer to a variable to be updated with the current image unit value. For more information on possible values, refer to the TWAIN specification.

Returns

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

Comments

This function gets the value of the image unit capability ICAP_UNITS. For more information on this capability, refer to the TWAIN specification.

To set the image unit capability value, call the L_TwainSetImageUnit 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_TwainSetImageUnit.

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.