DTWAIN_DestroyAcquisitionArray

Top  Previous  Next

The DTWAIN_DestroyAcquisitionArray function removes from memory a DTWAIN_ARRAY created with DTWAIN_CreateAcquisitionArray, DTWAIN_AcquireNative, or DTWAIN_AcquireBuffered functions.

 

DTWAIN_BOOL DTWAIN_DestroyAcquisitionArray (

DTWAIN_ARRAY

AcquisitionArray

DTWAIN_BOOL

bDeleteImageData );

 

Parameters

AcquisitionArray

A DTWAIN_ARRAY created by DTWAIN_CreateAcquisitionArray, or the return value of DTWAIN_AcquireNative or DTWAIN_AcquireBuffered.

 

bDeleteImageData

Determines whether to delete the acquired image data along with the DTWAIN_ARRAY.

 

Return Values

The return value is TRUE if successful.  Otherwise FALSE is returned.

 

Comments

The DTWAIN_DestroyAcquisitionArray function destroys a DTWAIN_ARRAY that has been created by calling DTWAIN_CreateAcquisitionArray or an array that was returned from the DTWAIN_AcquireNative or DTWAIN_AcquireBuffered functions.  If bEnable is TRUE, the image data contained in AcquisitionArray is also destroyed.  If bEnable is FALSE, only the DTWAIN_ARRAY is destroyed, but the image data is still left intact (for this case, the application should have saved the DIB or image handles for deletion later on).

 

Destroying the image data will remove any Device Independent Bitmaps (DIBS) or raw image data that was acquired.p

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN_CreateAcquisitionArray or DTWAIN_AcquireNative or DTWAIN_AcquireBuffered.