DTWAIN_ArrayAddFloatStringN

Top  Previous  Next

The DTWAIN_ArrayAddFloatStringN function adds N DTWAIN_FLOAT value to the end of a DTWAIN_ARRAY.

 

DTWAIN_BOOL DTWAIN_ArrayAddFloatStringN (

DTWAIN_ARRAY

Array,

LPCTSTR

Value,

LONG

NumCopies);

 

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

 

Value

DTWAIN_FLOAT value represented as a string

 
NumCopies

Number of copies of Value to add to the array.


Return Values

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

 

Character specific version

ANSI version:

DTWAIN_ArrayAddFloatStringNA

Unicode version:

DTWAIN_ArrayAddFloatStringNW


Comments

The DTWAIN_ArrayAddFloatStringN function appends NumCopies of the value Value to the end of the DTWAIN_ARRAY Array.  The number of elements in the DTWAIN_ARRAY is increased by NumCopies.  


The DTWAIN_ArrayAddFloatStringN function converts the string value represented by Value to a 64-bit IEEE floating point value, and appends this value to the end of the DTWAIN_ARRAY Array a total of NumCopies times.  The number of elements in the DTWAIN_ARRAY is increased by NumCopies.  


DTWAIN_ArrayAddFloatStringN allows applications to specify the floating point value as a string.  This allows applications that cannot handle 64-bit floating point types correctly (if at all), and gives them access to DTWAIN_ARRAY's that have been created with the DTWAIN_ARRAYFLOAT type.


The Value can have any C-standard, legal string representation of a floating point value. This includes strings with a single decimal point, scientific notation, etc.

 

This function will only work for DTWAIN_ARRAY's that can store DTWAIN_FLOAT values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYFLOAT style. See DTWAIN_ArrayCreate for more information).


See also DTWAIN_ArrayGetAtFloatString to retrieve a 64-bit value stored in a DTWAIN_ARRAYFLOAT as a string.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY