DTWAIN_GetPDFTextElementString

DTWAIN_GetPDFTextElementStringA

DTWAIN_GetPDFTextElementStringW

Top  Previous  Next

The DTWAIN_GetPDFTextElementString retrieves one of the string characteristics within a DTWAIN_PDFTEXTELEMENT.

 

LONG DTWAIN_GetPDFTextElementString (

DTWAIN_PDFTEXTELEMENT

TextElement,

LPTSTR

strArg,

LONG

MaxLen,

LONG

Item );

 

Parameters

TextElement

The DTWAIN_PDFTEXTELEMENT to set.

 

strArg

Character buffer that will store the retrieved item from the DTWAIN_PDFTEXTELEMENT or NULL.


MaxLen

The length of the string buffer strArg.

 

Item

The item within the DTWAIN_PDFTEXTELEMENT to retrieve


Return Values

The return value is the length of the text that is returned.  Otherwise 0 is returned.

 

Character specific version

ANSI version:

DTWAIN_GetPDFTextElementStringA

Unicode version:

DTWAIN_GetPDFTextElementStringW


Comments

The DTWAIN_GetPDFTextElementString gets the various string characteristics of TextElement.  


The strArg must be a buffer that is at least MaxLen in length or NULL.  If strArg is NULL, the return value will be the length of the text, and the 

MaxLen argument is ignored.


The Item denotes which values within TextElement to get.  The value of Item must be one of the following:


Value of Item

Values set within the DTWAIN_PDFTEXTELEMENT

DTWAIN_PDFTEXTELEMENT_FONTNAME

strArg is the name of one of the supported fonts (for example, "Helvetica")

DTWAIN_PDFTEXTELEMENT_TEXT

strArg is the text that will be shown on the page