DTWAIN_GetBrightnessString

DTWAIN_GetBrightnessStringA

DTWAIN_GetBrightnessStringW

The DTWAIN_GetBrightnessString function sets the current brightness value for the Source.

DTWAIN_BOOL DTWAIN_GetBrightnessString (

DTWAIN_SOURCE	Source
LPTSTR	lpBrightness );

Parameters

Source

An open TWAIN Source.

lpBrightness

String buffer. On return, this is filled in with the current brightness.

Return Values

TRUE if successful, FALSE otherwise. If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

Character specific versions

ANSI version:	DTWAIN_GetBrightnessStringA
Unicode version:	DTWAIN_GetBrightnessStringW

Comments

The DTWAIN_GetBrightnessString function works exactly the same way as DTWAIN_GetBrightness, with the exception of the lpBrightness parameter, which is a string buffer that will be filled on return with the brightness value. See DTWAIN_GetBrightness function for more details.

The LPTSTR arguments must point to a buffer large enough to hold the necessary string information. The string information will not exceed 255 characters.

TWAIN State Transitions

The Source must be in State 4. or higher

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN Source Selection Function