LAnnAutomation::GetText

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetText(pText)

/* character string to be updated */

Gets the text (character string) of the annotation object. This function is available in the Document/Medical Toolkits.

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

Returns

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

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

Functions:	LAnnAutomation::SetText, LAnnAutomation::GetTextLen, Class Members
Topics:	Annotation Functions: Object Properties

Example

/* This example gets and updates the property of the object passed by the caller */
void TestModifyAnn(LAnnAutomation L_FAR * pAnnObject)
{
   L_TCHAR L_FAR * pText; /* The object’s text */
   HGLOBAL hText; /* Handle for memory management */
   L_UINT 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 L_FAR *)GlobalLock( hText );
   /* Get the current text */
   pAnnObject->GetText(pText);
   /* Add " - New" to the end of the current text */
   lstrcat(pText,TEXT(" - New"));
   pAnnObject->SetText(pText, 0);

   /* Free memory that we no longer need */
   GlobalFree(hText);
}