DTWAIN_GetBrightness
|
The DTWAIN_GetBrightness function sets the current brightness value for the Source.
DTWAIN_BOOL DTWAIN_GetBrightness (
Parameters Source An open TWAIN Source.
lpBrightness Address of a DTWAIN_FLOAT (LPDTWAIN_FLOAT ). On return, this is filled in with the current brightness.
Return Values The return value is TRUE if successful. Otherwise FALSE is returned.
Comments The DTWAIN_GetBrightness function gets the current brightness value for the Source Source and on return, fills the DTWAIN_FLOAT that lpBrightness points to . Please note that lpBrightness is an address of a DTWAIN_FLOAT (an LPDTWAIN_FLOAT).
The Brightness argument denotes the brightness value of the acquired image. The brightness can be in the range between -1000.0 and +1000.0, with 0.0 being the default value for the brightness.
Note that some Sources do not support retrieving the brightness, so the return value for DTWAIN_GetBrightness will always be FALSE.
To set the current brightness value, call DTWAIN_SetBrightness.
For languages that have difficulties with DTWAIN_FLOAT parameters, the alternate function that can be used as a replacement for DTWAIN_GetBrightness is DTWAIN_GetBrightnessString.
TWAIN State Transitions The Source must be in State 4. or higher
Prerequisite Function Call(s)
DTWAIN Source Selection Function
See Also |