DTWAIN_ArrayGetAtFloat

Top Previous Next

The DTWAIN_ArrayGetAtFloat function retrieves a DTWAIN_FLOAT value from a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayGetAtFloat (

DTWAIN_ARRAY	Array,
LONG	Index,
LPDTWAIN_FLOAT	pValue );

Parameters

Array

DTWAIN_ARRAY that the value will be retrieved from.

Position

Index of value to retrieve.

pValue

Pointer to the DTWAIN_FLOAT that will receive the value.

Return Values

If the function succeeds, TRUE is returned. If the function fails FALSE is returned.

Comments

DTWAIN_ArrayGetAtFloat is a specialized version of DTWAIN_ArrayGetAt.

The DTWAIN_ArrayGetAtFloat function copies the DTWAIN_FLOAT 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.

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)

DTWAIN_SysInitialize