References ▼
#include "lttwn.h"
L_LTTWN_API L_INT L_TwainGetImageEffects(hSession, ulFlags, pBrightness, pContrast, pHighlight)
HTWAINSESSION hSession; |
handle to an existing TWAIN session |
L_UINT32 ulFlags; |
optional flags |
pTW_FIX32 pBrightness; |
pointer to a variable |
pTW_FIX32 pContrast; |
pointer to a variable |
pTW_FIX32 pHighlight; |
pointer to a variable |
Gets the current brightness, highlight and contrast values 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 or L_TwainInitSession2 function. | |
| ulFlags | Flags that indicate which capability values to get. Possible values are: | |
| Value | Meaning | |
| TWAIN_NEGOTIATE_BRIGHTNESS | [0x0010] Gets the brightness capability value. | |
| TWAIN_NEGOTIATE_CONTRAST | [0x0020] Gets the contrast capability value. | |
| TWAIN_NEGOTIATE_HIGHLIGHT | [0x0040] Gets the highlight capability value. | |
| pBrightness | Pointer to a variable to be updated with the current brightness capability value. For more information on possible values, refer to www.twain.org and click on TWAIN Specification (Version 2.0). | |
| pContrast | Pointer to a variable to be updated with the current contrast capability value. For more information on possible values, refer to www.twain.org and click on TWAIN Specification (Version 2.0). | |
| pHighlight | Pointer to a variable to be updated with the current highlight capability value. For more information on possible values, refer to www.twain.org and click on TWAIN Specification (Version 2.0). | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
This function gets the current brightness capability ICAP_BRIGHTNESS, highlight capability ICAP_HIGHLIGHT, and contrast capability ICAP_CONTRAST values. For more information on these capabilities, refer to www.twain.org and click on TWAIN Specification (Version 2.0).
To set these capabilities, call L_TwainSetImageEffects 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. |
For an example, refer to L_TwainSetImageEffects.