L_AnnGetTextOptions (original) (raw)
Summary
Gets the text options for the specified annotation object.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetTextOptions(hObject, pTextOptions, uStructSize)
Parameters
HANNOBJECT hObject
Handle to the annotation object.
pANNTEXTOPTIONS pTextOptions
Pointer to an ANNTEXTOPTIONS structure that specifies the text options to set.
L_UINT uStructSize
Size in bytes, of the structure pointed to by pTextOptions, for versioning. Use sizeof(ANNTEXTOPTIONS).
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
Use this function to get the text options of a text annotation object. To use this function, declare a variable of type ANNTEXTOPTIONS, and pass the address of this variable as the second argument. For more information, refer to the documentation for the structure ANNTEXTOPTIONS.
The hObject parameter can represent any annotation object type, but the return information is only useful for text annotatations.
Note: You must first enable this function by calling L_AnnSetOptions with the OPTIONS_NEW_TEXT_OPTIONS flag.
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_AnnSetTextOptions
- L_AnnSetText
- L_AnnGetText
- L_AnnGetTextLen
- L_AnnSetTextAlign
- L_AnnGetTextAlign
- L_AnnSetTextRotate
- L_AnnGetTextRotate
- L_AnnSetOptions
- L_AnnGetOptions
- L_AnnGetTextFixedSize
- L_AnnSetTextFixedSize
Topics
- Annotation Features
- Annotation Functions (Document/Medical only): Getting and Setting Text Properties
- Altering Annotation Object Settings
- User Interface for Container and Automation Objects
- Displaying and Manipulating Annotation Objects
- Obtaining Annotation Object Information
- Container Annotation Object
- Annotation Automation Object
- Text Annotation Object
- Text Pointer Annotation Object
- Stamp Annotation Object
- Note Annotation Object
- PushPin Annotation Object
- Button Annotation Object
Example
For an example, refer to L_AnnSetTextOptions
LEADTOOLS Raster Imaging C API Help