In This Topic ▼

L_AnnSetText

Summary

Sets the text (character string) of one or more annotation objects.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetText(hObject, pText, uFlags)

Parameters

L_TCHAR *pText

The character string to assign to the annotation object.

L_UINT uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

Value	Meaning
0	Process only the specified object.
ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions.
ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.
ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_TEXT menu item has been selected.

Returns

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

Comments

This function applies to multiple and selected objects based on values of the uFlags parameter.

This function does not affect objects that do not have this property or that do not let you change the property. For descriptions of the various types of objects and their properties, refer to Types of Annotations.

This function can be used to load unformatted text into an ANNOBJECT_RTF object. To load rich text into an ANNOBJECT_RTF object, see the documentation for L_AnnSetTextRTF.

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.

Example

L_INT AnnSetTextExample(HANNOBJECT hAnnObject) 
{ 
   L_INT       nRet; 
   L_TCHAR*    pText;         /* The object’s text */ 
   L_HGLOBAL   hText;         /* Handle for memory management */ 
   L_SIZE_T    zTextLength;   /* Length of the object’s text */ 
 
   /* Get the length of the current text */ 
   nRet = L_AnnGetTextLen(hAnnObject, &zTextLength); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Add six characters to the length for our new text */ 
   zTextLength = zTextLength + 60; 
 
   /* Allocate and lock a zero-filled buffer for the text */ 
   hText = GlobalAlloc(GPTR, zTextLength * sizeof(L_TCHAR)); 
   pText = (L_TCHAR*)GlobalLock(hText); 
 
   /* Get the current text */ 
   nRet = L_AnnGetText(hAnnObject, pText, &zTextLength); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Add " - New" to the end of the current text */ 
   lstrcat(pText, TEXT(" - New")); 
   nRet = L_AnnSetText(hAnnObject, pText, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Free memory that we no longer need */ 
   GlobalFree(hText); 
   return SUCCESS; 
}