DTWAIN_FrameGetValueString

DTWAIN_FrameGetValueStringA

DTWAIN_FrameGetValueStringW

Top  Previous  Next

The DTWAIN_FrameGetValueString function gets either the low, high, step, default, or current values in the DTWAIN_FRAME.

 

DTWAIN_BOOL DTWAIN_FrameGetValueString (

DTWAIN_FRAME

Frame,

LONG

WhichValue,

LPTSTR

lpValue );

 

Parameters

Frame

A valid DTWAIN_FRAME type.

 

WhichValue

Value to retrieve.

 

lpValue

Buffer where retrieved string will be copied.

 

Return Values

If the function succeeds, TRUE is returned.  If the function fails FALSE is returned.

 

Character specific version

ANSI version:

DTWAIN_FrameGetValueStringA

Unicode version:

DTWAIN_FrameGetValueStringW


Comments

The DTWAIN_FrameGetValueString function works exactly the same way as DTWAIN_FrameGetValue, with the exception of the lpValue points to a string buffer that will be filled on return with the value.

 

The LPTSTR argument must point to a buffer large enough to hold the necessary string information, or must be NULL if the value is to be ignored.  The string information will not exceed 255 characters.

  

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

DTWAIN Frame Functions