IG_PDF_word_get

Gets the bounding quadrilateral, expressed in user space coordinates, for a specific character from a word.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_word_get_charquad( HIG_PDF_WORD hWord, AT_WORD nByteIndex, LPAT_PDF_FIXEDQUAD lpQuad, LPAT_PDF_BOOL lpbHasQuad );

Arguments:

Name	Type	Description
hWord	HIG_PDF_WORD	The word to inspect.
nByteIndex	AT_WORD	The byte index of the character quad to obtain. The first character in a word has an index of zero. Use IG_PDF_word_get_length to identify the number of bytes in the word.
lpQuad	LPAT_PDF_FIXEDQUAD	Pointer to the character's quad, expressed in user-space coordinates. Upon successful completion, the memory referenced with this parameter is written with the character's quad.
lpbHasQuad	LPAT_PDF_BOOL	Pointer to memory that indicates whether the byte index has a quad. Upon successful completion, the memory referenced with this parameter is set to TRUE if the byte index has a quad; otherwise FALSE is set.

Return Value:

The number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

See IG_PDF_word_get_quad_count for a description of a quad.

The quad's height is the height of the font's bounding box, not the height of the tallest character used in the word. The font's bounding box is determined by the glyphs in the font that extend farthest above and below the baseline; it often extends somewhat above the top of "A" and below the bottom of "y."

The quad's width is determined from the characters actually present in the word.

As an example, the quads for the words "AWAY" and "away" have the same height, but generally do not have the same width unless the font is a mono-spaced font (a font in which all characters have the same width).