|
DTWAIN_ArraySetAtFloat |
Top Previous Next |
|
The DTWAIN_ArraySetAtFloat places a DTWAIN_FLOAT element in a DTWAIN_ARRAY.
DTWAIN_BOOL DTWAIN_ArraySetAtFloat (
Parameters Array DTWAIN_ARRAY that the value will be placed.
Index Position to place the element
Value DTWAIN_FLOAT value to be set in the DTWAIN_ARRAY.
Return Values If the function succeeds, TRUE is returned. If the function fails FALSE is returned.
Comments DTWAIN_ArraySetAtFloat is a specialized version of DTWAIN_ArraySetAt.
The DTWAIN_ArraySetAtFloat copies the value 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.
Unlike DTWAIN_ArrayInsertAtFloat, the DTWAIN_ArraySetAtFloat 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 DTWAIN_FLOAT values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYFLOAT style. See DTWAIN_ArrayCreate for more information).
TWAIN State Transitions None.
Prerequisite Function Call(s)
See Also |