L_AnnGetAutoTextLen

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoTextLen(hObject, uItem, puLen)

Gets the length of the current character string for a menu or dialog box item associated with automated annotations.

Parameters

HANNOBJECT hObject

Handle to the annotation automation object.

L_UINT uItem

Constant that specifies the menu or dialog box item, which appears when the user presses the right mouse button. For lists of constants and their default values, refer to the following:

Annotation Automation Menu Strings
Annotation Automation Line Dialog Strings
Annotation Automation Fill Dialog Strings
Annotation Automation Text Dialog Strings
Annotation Automation Audio Dialog Strings
Annotation Automation Stamp Dialog Strings
Annotation Automation ROP2 Dialog Strings
Annotation Automation Lock/Unlock Dialog Strings
Annotation Automation Miscellaneous Dialog Strings
Annotation Automation Ruler Dialog Strings
Annotation Automation Point Dialog Strings
Annotation Automation Video Dialog Strings
Annotation Automation Push Pin Dialog Strings
Annotation Automation Nodes Dialog Strings
Annotation Automation Protractor Dialog Strings
Annotation Automation Name Dialog Strings
Annotation Automation Play Video Dialog Strings
Annotation Automation Stamp Metafile Dialog Strings
Annotation Automation ToolTip Dialog Strings
Annotation Automation Transparent Color Dialog Strings
Annotation Automation Capture Dialog Strings
Annotation Automation Dialog Strings

L_SIZE_T *puLen

Pointer to unsigned integer variable that this function will update with the length of the item's current character string.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Once you know the length of the automated menu item, retrieve the text by calling L_AnnGetAutoText.

Use L_AnnSetAutoText to modify the text.

Before calling this function, you must declare an unsigned integer variable. Then, pass the address of the variable in the puLen parameter. This function will update the variable with the length of the automation item's character string.