References ▼
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetText(hObject, pText, puLen)
Gets the text (character string) of the specified annotation object.
Handle to the annotation object.
Pointer to a character string to be updated with the annotation object's character string.
Pointer to a variable to updated with the text length.
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
To use this function:
Declare a variable of type L_SIZE_T and pass the address of the variable as the puLen parameter
Pass NULL for the pText parameter
The length will be returned in the variable *puLen
Allocate a buffer of *puLen + 1
Call the function again passing the address of the buffer for pText
The text of the annotation object is returned in the buffer
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
Win32, x64.
For an example, refer to L_AnnSetText.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document