DTWAIN_ArrayAddStringN

Top  Previous  Next

The DTWAIN_ArrayAddStringN function adds N copies of a string value to the end of a DTWAIN_ARRAY.

 

DTWAIN_BOOL DTWAIN_ArrayAddStringN (

DTWAIN_ARRAY

Array,

LPCTSTR

Value,

LONG

NumCopies );

 

Parameters

Array

DTWAIN_ARRAY that the value will be added to.

 

Value

Pointer to character buffer.

 

NumCopies

Number of copies of Value to add to the array.


Return Values

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

 

Character specific version

ANSI version:

DTWAIN_ArrayAddStringNA

Unicode version:

DTWAIN_ArrayAddStringNW

 

Comments

The DTWAIN_ArrayAddStringN function appends NumCopies of 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 NumCopies.  

 

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

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Adding, Setting, and Inserting elements in a DTWAIN_ARRAY