DTWAIN_ArrayGetAtSource

Top  Previous  Next

The DTWAIN_ArrayGetAtSource function retrieves a DTWAIN_SOURCE value from a DTWAIN_ARRAY.

 

DTWAIN_BOOL DTWAIN_ArrayGetAtSource (

DTWAIN_ARRAY

Array,

LONG

Index,

LPDTWAIN_SOURCE

pValue );

 

Parameters

Array

DTWAIN_ARRAY that the value will be retrieved from.

 

Position

Index of value to retrieve.

 

pValue

Pointer to a DTWAIN_SOURCE that will receive the value.

 

Return Values

TRUE if successful, FALSE otherwise.  If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

 

Comments

DTWAIN_ArrayGetAtSource is a specialized version of DTWAIN_ArrayGetAt.

 

The DTWAIN_ArrayGetAtSource function copies the DTWAIN_SOURCE 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_SOURCE values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYSOURCE or an array that was returned using DTWAIN_EnumSources or DTWAIN_EnumSourcesEx


TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Retrieving Values from a DTWAIN_ARRAY