LAnnotation::GetFontName

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetFontName(pFontName, puLen)

L_TCHAR * pFontName;

/* character string to be updated */

L_UINT *puLen;

/* address of integer variable to be updated with text length */

Gets the font name (character string) for text in the annotation object.

Parameter

Description

pFontName

Character string to be updated with the name of the font used by the annotation object.

puLen

Pointer to a variable to be updated with the length of pFontName string.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To get the font name, the user should:

1.

Declare a variable of type L_UINT.

2.

Call this function passing the address of the variable as the puLen parameter and pFontName as NULL. The length will be returned in the variable *puLen.

3.

Allocate a buffer of size *puLen.

4.

Call this function passing the allocated buffer to the pFontName parameter to obtain the text.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

LAnnotation::SetFontName, LAnnotation::GetFontNameLen, LAnnotation::SetFontSize, LAnnotation::GetFontSize, LAnnotation::SetFontUnderline, LAnnotation::IsFontUnderline, LAnnotation::SetFontStrikeThrough, LAnnotation::IsFontStrikeThrough, LAnnotation::SetFontItalic, LAnnotation::IsFontItalic, LAnnotation::SetFontBold, LAnnotation::IsFontBold, Class Members

Topics:

Annotation Functions: Object Properties

Example

For an example, refer to LAnnotation::SetNameOptions.