DTWAIN_ArrayGetAtString

The DTWAIN_ArrayGetAtString function retrieves a string value from a DTWAIN_ARRAY.

DTWAIN_BOOL DTWAIN_ArrayGetAtString (

Parameters

Array

DTWAIN_ARRAY that the value will be retrieved from.

Position

Index of value to retrieve.

pValue

Pointer to the character buffer that will receive the value.

Return Values

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

Comments

DTWAIN_ArrayGetAtString is a specialized version of DTWAIN_ArrayGetAt.

The DTWAIN_ArrayGetAtString function copies the string 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.  Note that pValue must point to a character buffer that is at least 255 characters in length before calling DTWAIN_ArrayGetAtString.  The returned string is null-terminated.

This function will only work for DTWAIN_ARRAY's that can store string values (i.e. the DTWAIN_ARRAY was created with the DTWAIN_ARRAYSTRING style. See DTWAIN_ArrayCreate for more information).

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize

See Also

Retrieving Values from a DTWAIN_ARRAY