In This Topic ▼

LAnnotation::GetTextOptions

#include "ltwrappr.h"

L_INT LAnnotation::GetTextOptions(pTextOptions, uStructSize)

Sets the text options for the annotation object.

Parameters

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. If the annotation objects are container, automation, text, text pointer, stamp, note, pushpin, or button objects it is possible to use the LAnnotation::GetTextOptions and the LAnnotation::SetTextOptions functions to set the objects to show or hide the text and to set the color of the text. In addition, if the annotation objects are text or stamp objects these functions can set the objects to show or hide the borders of the object. These features must be enabled using the LAnnotation::SetOptions function. 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 class object parameter can represent any annotation object type, but the return information is only useful for text annotations.

Note: Enable this function by calling LAnnotation::SetOptions with the OPTIONS_NEW_TEXT_OPTIONS flag.