L_TwainGetImageUnit
#include "lttwn.h"
L_LTTWN_API L_INT L_TwainGetImageUnit (hSession, pnUnit)
HTWAINSESSION hSession; |
/* handle to an existing TWAIN session */ |
L_INT * pnUnit; |
/* pointer to a variable */ |
Gets the current image unit value 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. |
pnUnit |
Pointer to a variable to be updated with the current image unit value. 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 gets the value of the image unit capability ICAP_UNITS. For more information on this capability, refer to www.twain.org/download.htm and click on TWAIN Specification (Version 1.9).
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
Example
For an example, refer to L_TwainSetImageUnit.