DTWAIN_ArrayGetAtFrame

The DTWAIN_ArrayGetAtFrame function retrieves a DTWAIN_FRAME value from a DTWAIN_ARRAY.

DTWAIN_FRAME DTWAIN_ArrayGetAtFloat (

DTWAIN_ARRAY	Array,
LONG	Index );

Parameters

Array

DTWAIN_ARRAY that the value will be retrieved from.

Position

Index of DTWAIN_FRAME value to retrieve.

Return Values

If the function succeeds, A DTWAIN_FRAME is returned. If the function fails, NULL is returned.

Comments

DTWAIN_ArrayGetAtFrame is a specialized version of DTWAIN_ArrayGetAt.

The DTWAIN_ArrayGetAtFrame function returns the DTWAIN_FRAME value located at index Index. 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_FRAME values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYFRAME style. See DTWAIN_ArrayCreate for more information).

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize