L_TwainGetImageUnit

Summary

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

Syntax

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

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

• 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_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_TwainSetImageUnit.