DTWAIN_ArrayAddWideString

Top  Previous  Next

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

 

DTWAIN_BOOL DTWAIN_ArrayAddWideString (

DTWAIN_ARRAY

Array,

LPCWSTR

Value );

 

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

 

Value

Pointer to character buffer.

 

Return Values

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

 

Comments

The DTWAIN_ArrayAddWideString 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_ArrayAddWideString 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_ARRAYWIDESTRING style

or

2) with the DTWAIN_ARRAYSTRING style if using the Unicode version of the DTWAIN library (DTWAIN32U.DLL, DTWAIN64U.DLL).

 

To insert 8-bit or ANSI character strings, use DTWAIN_ArrayAddANSIString.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY