LAnnAutomation::SetAutoText
#include "ltwrappr.h"
virtual L_INT LAnnAutomation::SetAutoText(uItem, pText)
L_UINT uItem; |
/* constant for the specified item */ |
/* character string for the item */ |
Specifies the character string for a menu or dialog box item associated with automated annotations. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
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: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
pText |
Character string to use for the menu or dialog box item. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To retrieve the character string for a menu item or dialog box item, use LAnnAutomation::GetAutoTextLen to determine the length of the string and to allocate a buffer of appropriate size. Then call LAnnAutomation::GetAutoText to retrieve the string.
When you call LAnnAutomation::SetAutoText, if you pass an empty string, the menu item defined by uItem will be disabled and removed from the automation menu. To re-enable the menu item, call LAnnAutomation::SetAutoText and pass a valid 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. |
See Also
Example
For an example, refer to LAnnAutomation::GetAutoText.