LAnnRuler::GetText

#include "ltwrappr.h"

virtual L_INT LAnnRuler::GetText(pText, puLen)

L_TCHAR * pText;	/* character string to be updated */
L_SIZE_T *puLen;	/* address of an integer variable to be updated with text length*/

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

Parameter	Description
pText	Character string to be updated with the annotation object's character string.
puLen	Pointer to a variable to updated with the text length.

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.

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:	Class Members
Topics:	Annotation Functions: Object Properties

Example

L_INT LAnnRuler_GetTextExample(LAnnRuler  * 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,NULL);
	if(nRet != SUCCESS)
		return nRet;
/* Free memory that we no longer need */
   GlobalFree(hText);   
	return SUCCESS;
}