LAnnAutomation::SetAutoText

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetAutoText(uItem, pText)

Specifies the character string for a menu or dialog box item associated with automated annotations.

Parameters

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:

L_TCHAR * pText

Character string to use for the menu or dialog box item.

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to LAnnAutomation::GetAutoText.

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

LEADTOOLS Raster Imaging C++ Class Library Help