L_AnnGetText
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnGetText(hObject, pText)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
/* address of the character string to be updated */ |
Gets the text (character string) of the specified annotation object. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle to the annotation object. |
|
pText |
Pointer to a character string to be updated with the annotation object's character string. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable as a pointer to a character string. Then, pass the variable in the pText parameter. This function will update the variable with the annotation object's character string.
Note: The text of the ruler object (which can be retrieved through L_AnnGetText and L_AnnGetTextLen 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
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
|
Functions: |
L_AnnSetText, L_AnnGetTextLen, L_AnnGetAutoText, L_AnnGetAutoTextLen, L_AnnSetAutoText, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
For an example, refer to L_AnnSetText.