DTWAIN_ArrayCreateFromCap

Top  Previous  Next

The DTWAIN_ArrayCreateFromCap creates a DTWAIN_ARRAY that is compatible with a device capability's value(s).

 

DTWAIN_ARRAY DTWAIN_ArrayCreateFromCap (

DTWAIN_SOURCE

Source,

LONG

CapValue,

LONG

NumItems );

 

Parameters

Source

A valid DTWAIN_SOURCE if CapValue is a custom capability.  NULL otherwise.

 

CapValue

Device capability to use when creating array.

 

NumItems

Number of values that the array can store initially.

 

Return Values

If the function succeeds, a new DTWAIN_ARRAY is returned.  Otherwise, NULL is returned.

 

Comments

The DTWAIN_ArrayCreateFromCap function returns a new DTWAIN_ARRAY of the type that is the same type that the device capability CapValue will need to store values.  The DTWAIN_ArrayCreateFromCap function can be used to create a DTWAIN_ARRAY that is to be used for the DTWAIN_SetCapValues function.  

 

If the capability CapValue is a custom capability (the capability value is >= 32,768), the Source argument must be a valid DTWAIN_SOURCE that supports the custom capability.  Otherwise, the Source argument should be NULL.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

DTWAIN_ARRAY Creation and Destruction