L_TwainSetImageBitsPerPixel

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainSetImageBitsPerPixel(hSession, nBitsPerPixel)

HTWAINSESSION hSession;	/* handle to an existing TWAIN session */
L_INT nBitsPerPixel;	/* bits per pixel */

Sets the bits per pixel to be used when transferring images from the current TWAIN source.

Parameter	Description
hSession	Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession function.
nBitsPerPixel	Number of bits per pixel to set. For more information on possible values, refer to www.twain.org/download.htm and click on TWAIN Specification (Version 1.9).

Returns

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

Comments

This function internally sets the bits per pixel capability ICAP_BITDEPTH. For more information on this capability, refer to www.twain.org/download.htm and click on TWAIN Specification (Version 1.9).

To obtain the current bits per pixel value, call the L_TwainGetImageBitsPerPixel 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_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.