LAnnNote::GetFontName

Show in webframe

#include "ltwrappr.h"

virtual L_INT LAnnNote::GetFontName(pFontName, puLen)

L_TCHAR * pFontName;	/* character string to be updated */
L_UINT *puLen;	/* address of integer variable to be updated with text length */

Gets the font name (character string) for text in the annotation object.

NOTE: THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Parameter	Description
pFontName	Character string to be updated with the name of the font used by the annotation object.
puLen	Pointer to a variable to be updated with the length of pFontName string.

Returns

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

Comments

pFontName must be large enough to hold the returned 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 LAnnNote_GetFontNameExample(LAnnNote  * pAnnObject)
{
   L_INT nRet;
   L_TCHAR  * pFontName; /* The object's font name. */
   L_UINT uNameLength;/* Length of the object's font name */
   LBuffer LeadBuffer ;
   /* Get the length of the current font name */
   uNameLength = pAnnObject->GetFontNameLen();
   
   LeadBuffer.Reallocate((DWORD)uNameLength * sizeof(L_TCHAR)) ;
   
   pFontName = (L_TCHAR  *)LeadBuffer.Lock() ;
   /* Get the current font name */
   nRet = pAnnObject->GetFontName(pFontName, &uNameLength);
   if(nRet != SUCCESS)
      return nRet;
   /* Set the font to Times New Roman, unless it already is */
   if (lstrcmp(pFontName,TEXT("Times New Roman")) == 0)
       MessageBox (NULL, TEXT("Already Times New Roman"), TEXT("Notice"), MB_OK);
   else
   {
      nRet = pAnnObject->SetFontName( TEXT("Times New Roman"), 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   LeadBuffer.Unlock() ;
   return SUCCESS;
}