In This Topic ▼

L_AnnGetAutoText

Summary

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

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoText(hObject, uItem, pText, puLen)

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:

L_TCHAR *pText

Pointer to the buffer to be updated with the item's character string.

L_SIZE_T *puLen

Pointer to variable to be updated 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

To use this function:

Call this function passing pText as NULL to obtain the text length in the puLen parameter.
Allocate a buffer of size (*puLen + 1).
Call this function with passing the allocated buffer to the pText parameter to obtain the text.

Use L_AnnSetAutoText to modify the automated menu item.

Before calling this function, you must declare a variable as a pointer to a character string. Then, pass the variable in the pText parameter. This function will update the variable with 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

Win32, x64.

Example

This example adds " - New" to the current "&Undo" menu item.

L_INT AnnAutoTextExample(HANNOBJECT hAutoObject /* Automation object */) 
{ 
   L_INT       nRet = SUCCESS; 
   L_TCHAR*    pText = NULL;     // The object’s text 
   L_HGLOBAL   hText = 0;        // Handle for memory management 
   L_SIZE_T    nTextLength = 0;  // Length of the object’s text 
 
   // Get the length of the current text 
   nRet = L_AnnGetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, NULL, &nTextLength); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   // Allocate and lock a zero-filled buffer for the text 
   hText = GlobalAlloc(GPTR, (nTextLength + 6) * sizeof(L_TCHAR)); 
   pText = (L_TCHAR*)GlobalLock(hText); 
 
   // Get the current text 
   nRet = L_AnnGetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText, &nTextLength); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   //Add " - New" to the end of the current text 
   lstrcat(pText, TEXT(" - New")); 
   nRet = L_AnnSetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   // Free memory that we no longer need 
   GlobalFreePtr(pText); 
   return SUCCESS; 
}