L_TwainGetImageBitsPerPixel

Summary

Gets the current bits per pixel value used when transferring images from the current TWAIN source.

Syntax

L_LTTWN_API L_INT L_TwainGetImageBitsPerPixel(hSession, pnBitsPerPixel)

Parameters

HTWAINSESSION hSession

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

L_INT * pnBitsPerPixel

Pointer to a variable to be updated with the number of bits per pixel. For more information on possible values, refer to the TWAIN specification.

Returns

Comments

This function gets the bits per pixel capability ICAP_BITDEPTH. For more information on this capability, refer to the TWAIN specification.

To set the bits per pixel capability, call the L_TwainSetImageBitsPerPixel 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_TwainGetImageUnit
• L_TwainSetImageBitsPerPixel
• 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.