DTWAIN_ArrayAddString
|
The DTWAIN_ArrayAddString function adds a string value to the end of a DTWAIN_ARRAY.
DTWAIN_BOOL DTWAIN_ArrayAddString (
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.
Character specific version
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, DTWAIN_ARRAYANSISTRING, DTWAIN_ARRAYWIDESTRING style. See DTWAIN_ArrayCreate for more information). It is the responsibility of the application to store the correct string type (ANSI / Unicode) in the string array. For example, if your application attempts to store char-based (ANSI) strings in a DTWAIN_ARRAY that was created to take wide (Unicode) strings, DTWAIN has no way of checking if the string is of the correct type, thus your application will more than likely not behave correctly when attempting to access the strings within the array. TWAIN State Transitions None.
Prerequisite Function Call(s)
See Also |