DTWAIN_ArrayGetAt
|
The DTWAIN_ArrayGetAt function retrieves a value from a DTWAIN_ARRAY.
DTWAIN_BOOL DTWAIN_ArrayGetAt (
Parameters Array DTWAIN_ARRAY that the value will be retrieved from.
Position Index of value to retrieve.
pValue 32-bit pointer to the address of the retrieved value.
Return Values If the function succeeds, TRUE is returned. If the function fails FALSE is returned.
Comments The DTWAIN_ArrayGetAt function copies the value located at index Index to the address pValue. A DTWAIN_ARRAY is indexed starting from position 0 through position n-1, where n is the total number of items in the DTWAIN_ARRAY Array.
The data type of the value located at the address pValue must match the data type that is stored in Array (see DTWAIN_ARRAY Data Types). DTWAIN cannot determine the data type located at address pValue, therefore it is the responsibility of the programmer to provide the correct type.
TWAIN State Transitions None.
Prerequisite Function Call(s)
See Also |