DTWAIN_GetPDFTextElementFloat

Top  Previous  Next

The DTWAIN_GetPDFTextElementFloat gets one of the floating point characteristics within a DTWAIN_PDFTEXTELEMENT.

 

DTWAIN_BOOL DTWAIN_GetPDFTextElementFloat (

DTWAIN_PDFTEXTELEMENT

TextElement,

LPDTWAIN_FLOAT

arg1,

LPDTWAIN_FLOAT

arg2,

LONG

Item );

 

Parameters

TextElement

The DTWAIN_PDFTEXTELEMENT to retrieve the values from.

 

arg1, arg2

Pointers to DTWAIN_FLOAT that will be used to return the DTWAIN_PDFTEXTELEMENT values

 

Item

The item within the DTWAIN_PDFTEXTELEMENT to get


Return Values

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

 

Comments

The DTWAIN_GetPDFTextElementFloat gets the various floating point characteristics of TextElement.


The values that will be used are described in two arguments arg1 and arg2


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


Value of Item

Values retrieved within the DTWAIN_PDFTEXTELEMENT

DTWAIN_PDFTEXTELEMENT_CHARSPACING

arg1 is character spacing, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_FONTHEIGHT

arg1 is font height, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_ROTATIONANGLE

arg1 is the rotation angle of the text in degrees, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_SCALING

arg1 is scaling for non-rotated (horizontal) text, arg2 is ignored.

DTWAIN_PDFTEXTELEMENT_SCALINGXY

arg1 is x-scaling, arg2 is y-scaling (only used for rotated text)

DTWAIN_PDFTEXTELEMENT_STROKEWIDTH

arg1 is the stroke width, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_SKEWANGLES

arg1 is the x skew angle, arg2 is the y skew angle

DTWAIN_PDFTEXTELEMENT_WORDSPACING 

arg1 is word spacing, arg2 is ignored