L_AnnGetText

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetText(hObject, pText, puLen)

HANNOBJECT hObject;

/* handle to the annotation object */

L_TCHAR *pText;

/* address of the character string to be updated */

L_SIZE_T *puLen;

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

Gets the text (character string) of the specified annotation object.

Parameter

Description

hObject

Handle to the annotation object.

pText

Pointer to a character string to be updated with the annotation object's character string.

puLen

Pointer to a variable to updated with the text length.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To use this function:

Note: The text of the ruler object (which can be retrieved through L_AnnGetText) is the length + unit abbrev. The distance is reset every time the object is changed.

L_AnnGetText can be used to retreive the text from a Rich Text annotation object (ANNOBJECT_RTF). However, no formatting information will be preserved. To retrieve the text with formatting, see L_AnnGetTextRTF.

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:

L_AnnSetText, L_AnnGetAutoText, L_AnnGetAutoTextLen, L_AnnSetAutoText, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Obtaining Annotation Object Information

Example

For an example, refer to L_AnnSetText.