LAnnAutomation::GetAutoText

Show in webframe

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetAutoText(uItem, pText, puLen)

L_UINT uItem;	/* constant that specifies the menu or dialog box item */
L_TCHAR * pText;	/* items character string */
L_SIZE_T *puLen;	/* pointer to the variable to be updated */

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

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:
	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
pText	Character string to be updated with the items character string.
puLen	Pointer to variable to be updated 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

Before calling this function, call LAnnAutomation::GetAutoTextLen to get the length of the text you want to retrieve.

Use LAnnAutomation::SetAutoText 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.

See Also

Functions:	LAnnAutomation::GetAutoTextLen, LAnnAutomation::SetAutoText, Class Members, LAnnAutomation::SetAutoHilightPen, LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor, LAnnAutomation::GetAutoHilightPen
Topics:	Annotation Functions: Implementing Automation

Example

This example adds " - New" to the current "&Undo"

menu item.

L_INT LAnnAutomation_GetAutoTextExample(LAnnAutomation  * pAnnAutomation)
{
   L_INT nRet;
   L_TCHAR  * pText; /* The object's text */
   HGLOBAL hText; /* Handle for memory management */
   L_SIZE_T TextLength; /* Length of the object's text */
   /* Get the length of the current text */
   TextLength = pAnnAutomation->GetAutoTextLen(ANNAUTOTEXT_MENU_UNDO);
   /* Add six characters to the length for our new text  */
   TextLength +=6;
   /* Allocate and lock a zero-filled buffer for the text */
   hText = GlobalAlloc(GPTR,TextLength*sizeof(L_TCHAR) );
   pText = (L_TCHAR  *)GlobalLock( hText );
   /* Get the current text */
   nRet = pAnnAutomation->GetAutoText(ANNAUTOTEXT_MENU_UNDO, pText,&TextLength);
   if(nRet != SUCCESS)
      return nRet;
   /* Add " - New" to the end of the current text */
   lstrcat(pText,TEXT(" - New"));
   nRet = pAnnAutomation->SetAutoText(ANNAUTOTEXT_MENU_UNDO, pText);
   if(nRet != SUCCESS)
      return nRet;
   /* Free memory that we no longer need */
   GlobalFree(hText);
   return SUCCESS;
}