DTWAIN_ClearPDFTextElements

Top  Previous  Next

The DTWAIN_ClearPDFTextElements function removes all of the DTWAIN_PDFTEXTELEMENTs that were added to the Source with DTWAIN_AddPDFTextElement

 

DTWAIN_BOOL DTWAIN_ClearPDFTextElements ( DTWAIN_SOURCE Source )

 

Parameters

Source

    Specifies an open TWAIN Source.

 

Return Values

TRUE if successful, FALSE otherwise.  If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

 

Comments

The DTWAIN_ClearPDFTextElements function clears all of the DTWAIN_PDFTEXTELEMENT objects that will be written to PDF pages. 


If the application has called DTWAIN_AcquireFile or DTWAIN_AcquireFileEx, and has specified either DTWAIN_PDF or DTWAIN_PDFMULTI as the file type, DTWAIN_PDFTEXTELEMENT objects that were added using DTWAIN_AddPDFTextElement will remain within the source until either the application is closed, or DTWAIN_ClearPDFTextElements is called.


Please note:  A DTWAIN_PDFTEXTELEMENT that was added by DTWAIN_AddPDFTextElement with a displayFlags value of DTWAIN_PDFTEXT_CURRENTPAGE is automatically removed by DTWAIN on every page that is generated.