L_AnnGetTextOptions
#include "l_bitmap.h"
EXT_FUNCTION L_AnnGetTextOptions(hObject, pTextOptions, uStructSize)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
pANNTEXTOPTIONS pTextOptions; |
/* pointer to a structure that specifies the text options */ |
|
L_UINT uStructSize; |
/* size of the ANNTEXTOPTIONS structure */ |
Gets the text options for the specified annotation object. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle to the annotation object. |
|
pTextOptions |
Pointer to an ANNTEXTOPTIONS structure that specifies the text options to set. |
|
uStructSize |
Size in bytes, of the structure pointed to by pTextOptions, for versioning. Use sizeof(ANNTEXTOPTIONS). |
Returns
|
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 a 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: In Version 14.5, you need first to 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
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
Example
For an example, refer to L_AnnSetTextOptions