DTWAIN_ArraySetAtString
|
The DTWAIN_ArraySetAtString places a string element in a DTWAIN_ARRAY.
DTWAIN_BOOL DTWAIN_ArraySetAtString (
Parameters Array DTWAIN_ARRAY that the value will be placed.
Index Position to place the element
Value Pointer to string to be set in the DTWAIN_ARRAY.
Return Values If the function succeeds, TRUE is returned. If the function fails FALSE is returned.
Character specific version
Comments DTWAIN_ArraySetAtString is a specialized version of DTWAIN_ArraySetAt.
The DTWAIN_ArraySetAtString copies the string pointed to by Value to a position in the DTWAIN_ARRAY Array. The Index argument is the position to place the value, and must be in the range of 0 to n-1 where n is the number of elements in the array. The string must be a null-terminated string.
Unlike DTWAIN_ArrayInsertAtString, the DTWAIN_ArraySetAtString function replaces the value located at the position instead of inserting the value and moving existing elements down.
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).
For storing specifically ANSI or Wide strings, use DTWAIN_ArraySetAtANSIString or DTWAIN_ArraySetAtWideString, respectively.
TWAIN State Transitions None.
Prerequisite Function Call(s)
See Also Adding, Setting, and Inserting elements in a DTWAIN_ARRAY
|