DTWAIN_ArrayAddString

Top Previous Next

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

DTWAIN_BOOL DTWAIN_ArrayAddString (

DTWAIN_ARRAY	Array,
LPCTSTR	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.

Character specific version

ANSI version:	DTWAIN_ArrayAddStringA
Unicode version:	DTWAIN_ArrayAddStringW

Comments

The DTWAIN_ArrayAddString 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_ArrayAddString is a specialized version of DTWAIN_ArrayAdd for string values.

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