L_AnnGetAutoTextLen
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetAutoTextLen(hObject, uItem, puLen)
HANNOBJECT hObject; |
/* automation object */ |
L_UINT uItem; |
/* constant for the specified item */ |
L_SIZE_T *puLen; |
/* pointer to the variable to be updated */ |
Gets the length of the current character string for a menu or dialog box item associated with automated annotations.
This function is available in the Document and Medical Imaging toolkits.
Parameter |
Description |
hObject |
Handle to the annotation automation object. |
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: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
puLen |
Pointer to unsigned integer variable that this function will update with the length of the item's current character string. |
Returns
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.
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 2000 / XP/Vista.
See Also
Functions: |
L_AnnGetAutoText, L_AnnSetAutoText, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
Topics: |
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Automation Properties |
Example
For an example, refer to L_AnnGetAutoText.