DTWAIN_ArrayFix32GetAt

Top Previous Next

The DTWAIN_ArrayFix32GetAt gets the Integer and Fractional portions of a fixed point value within an array of fixed point values.

DTWAIN_BOOL DTWAIN_ArrayFix32GetAt (

DTWAIN_ARRAY	Array,
LONG	Index,
LPLONG	Whole,
LPLONG	Frac );

Parameters

Array

A DTWAIN_ARRAY that holds fixed point values.

Index

Position in array to get the fixed point element

Whole

Pointer to LONG value that will get the integer portion of the fixed point value.

Frac

Pointer to LONG value that will get the fractional portion of the fixed point value.

Return Values

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

Comments

The DTWAIN_ArrayFix32GetAt function gets the integer and fractional portions of an entry in a DTWAIN_ARRAY that consists of fixed point values. The Index is the element within the array. The Whole is the address of a LONG that will receive the integer portion, and the Frac is the address of the LONG that weill receive the fractional portion of the number when the function returns..

The usage of DTWAIN_ArrayFix32GetAt should be used for computer languages utilizing that DTWAIN that has minimal, if any floating point support for IEEE 64-bit floating point values (DTWAIN_FLOAT). Languages such as Macro Scheduler, XBase++, and other languages that lack proper floating point support should utilize this and other floating point functions instead of the traditional DTWAIN functions that handle floating point data. See Floating Point Issues in this manual for more information, as well as the examples that shows usage of this and other functions.

Since most computer languages handle DTWAIN_FLOAT with no issues, the DTWAIN_ArrayFix32GetAt should rarely be used, if it is ever used.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize