Collapse All Expand All

LAnnAudioClip::GetText

#include "ltwrappr.h"

virtual L_INT LAnnAudioClip::GetText(pText, puLen)

L_TCHAR * pText;	/* character string to be updated */
L_SIZE_T *puLen;	/* pointer to a variable to updated with the 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

This example gets and updates the property of

the object passed by the caller

L_INT LAnnAudioClip_GetTextExample(LAnnAudioClip  * pAnnObject)
{
   L_INT nRet;
   L_TCHAR  *pText; /* The object's text */
   L_SIZE_T TextLength; /* Length of the object's text */
   LBuffer LeadBuffer ;
   /* Get the length of the current text */
   TextLength = pAnnObject->GetTextLen();
   /* Add six characters to the length for our new text */
   TextLength += 6;
   nRet = LeadBuffer.Reallocate((DWORD)TextLength*sizeof(L_TCHAR));
   if(nRet != SUCCESS)
      return nRet;
   pText = (L_TCHAR  *)LeadBuffer.Lock() ;
   /* 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;
   LeadBuffer.Unlock();
   return SUCCESS;
  }