LAnnAutomation::GetText

Summary

Gets the text (character string) of the annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetText(pText, puLen)

Parameters

L_TCHAR * pText

Character string to be updated with the annotation object's character string.

L_SIZE_T *puLen

Pointer to a variable to updated with the text length.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

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 annotation object's character string.

GetText can be used to retrieve text that was set using LAnnAutomation::SetTextRTF, but no formatting information will be preserved. To retrieve the text with formatting, use LAnnAutomation::GetTextRTF.

Note: The text of the ruler object, which can be retrieved through LAnnRuler::GetText and LAnnRuler::GetTextLen, is the length + unit abbrev. The distance is reset every time the object is changed.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

This example gets and updates the property of the object
passed by the caller

L_INT LAnnAutomation_GetTextExample(LAnnAutomation  * pAnnObject) 
 
{ 
   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 = pAnnObject->GetTextLen(); 
 
   /* 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 = pAnnObject->GetText(pText,&TextLength); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Add " - New" to the end of the current text */ 
 
   lstrcat(pText,TEXT(" - New")); 
 
   nRet = pAnnObject->SetText(pText, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Free memory that we no longer need */ 
 
   GlobalFree(hText);  
 
   return SUCCESS; 
} 

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

LEADTOOLS Raster Imaging C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.