DTWAIN_RemovePDFTextElement

Top  Previous  Next

The DTWAIN_RemovePDFTextElement function removes a DTWAIN_PDFTEXTELEMENT that was added to the Source with DTWAIN_AddPDFTextElement

 

DTWAIN_BOOL DTWAIN_RemovePDFTextElement (

DTWAIN_SOURCE

Source

DTWAIN_PDFTEXTELEMENT

TextElement );


 

Parameters

Source

    Specifies an open TWAIN Source.

 

TextElement

A DTWAIN_PDFTEXTELEMENT that describes the text, font, etc.


Return Values

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

 

Comments

The DTWAIN_RemovePDFTextElement function clears a single DTWAIN_PDFTEXTELEMENT object that will be written to PDF pages. Once a text element is removed, the text will no longer appear on the PDF pages.


To clear all of the text elements, use DTWAIN_ClearPDFTextElements.


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.  


See Also

DTWAIN_AddPDFTextElement