LAnnVideo::GetText

#include "ltwrappr.h"

virtual L_INT LAnnVideo::GetText(pText, puLen)

L_TCHAR * pText;

/* character string to be updated with the annotation object's character string */

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
LTMM

For a listing of the exact DLLs and Libraries needed for LTANN, based on the toolkit version, refer to Files To Be Included With Your Application.

For a listing of the exact DLLs and Libraries needed for LTMM, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

Example

L_INT LAnnVideo_GetTextExample()
{
   LSettings::UnlockSupport(L_SUPPORT_DOCUMENT, L_KEY_DOCUMENT);
   LAnnVideo MyAnnVideo;
   L_TCHAR szTemp[100], szFileName[100];
   MyAnnVideo.SetText(TEXT("c:\\video.avi"));
   L_SIZE_T uFileLen = MyAnnVideo.GetTextLen();
   MyAnnVideo.GetText(szFileName, &uFileLen);
   wsprintf(szTemp, 
            TEXT("Capture File Name: %s\nCapture File Name Length: %d"),
            szFileName,
            uFileLen);
   AfxMessageBox(szTemp);
   return SUCCESS;
}