L_AnnGetTextOptions

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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to L_AnnSetTextOptions

Help Version 22.0.2022.10.26
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.