DTWAIN_ArrayAddANSIString

Top  Previous  Next

The DTWAIN_ArrayAddANSIString function adds a string value to the end of a DTWAIN_ARRAY.

 

DTWAIN_BOOL DTWAIN_ArrayAddANSIString (

DTWAIN_ARRAY

Array,

LPCSTR

Value );

 

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

 

Value

Pointer to character buffer.

 

Return Values

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

 

 

Comments

The DTWAIN_ArrayAddANSIString function appends the contents of the buffer located at Value to the end of the DTWAIN_ARRAY Array.  The number of elements in the DTWAIN_ARRAY is increased by 1.  DTWAIN_ArrayAddANSIString is a specialized version of DTWAIN_ArrayAdd for string values.

 

This function will only work for DTWAIN_ARRAY's that can store wide (Unicde) or 16-bit character strings values.  The DTWAIN_ARRAY must be created  with

 

1) The DTWAIN_ARRAYANSISTRING style

or

2) with the DTWAIN_ARRAYSTRING style if using the ANSI version of the DTWAIN library (DTWAIN32.DLL, DTWAIN64.DLL).

 

To insert 16-bit (Unicode) character strings, use DTWAIN_ArrayAddWideString.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY