DTWAIN_ArrayGetStringLength

Top  Previous  Next

The DTWAIN_ArrayGetStringLength function returns the length of a string stored in a DTWAIN_ARRAY.

 

LONG DTWAIN_ArrayGetStringLength (

DTWAIN_ARRAY

Array,

LONG

Index );

 

Parameters

Array

DTWAIN_ARRAY that the value will be retrieved from.

 

Index

Index of string to get the length of

 

 

Return Values

If the function succeeds, the character length of the string stored at the given indes.  If the function fails, a negative number denoting a DTWAIN error is returned.

 

Comments

The DTWAIN_ArrayGetStringLength function returns the number of characters in the string at position Index of the DTWAIN_ARRAY Array.  The DTWAIN_ARRAY must be one that is designed to hold string data (see DTWAIN_ArrayCreate for more information).

 

Please note:  If the string stored in the DTWAIN_ARRAY is one that consists of wide (Unicode) characters, the length is the number of characters (not bytes) that the string consists of.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

Retrieving Values from a DTWAIN_ARRAY