LAnnAutomation::GetFontName

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetFontName(pFontName)

L_TCHAR * pFontName;

/* character string to be updated */

NOTE:

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

Gets the font name (character string) for text in the annotation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

pFontName

Character string to be updated with the name of the font used by the annotation object.

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.

See Also

Functions:

LAnnAutomation::SetFontName, LAnnAutomation::GetFontNameLen, LAnnAutomation::SetFontSize, LAnnAutomation::GetFontSize, LAnnAutomation::SetFontUnderline, LAnnAutomation::IsFontUnderline, LAnnAutomation::SetFontStrikeThrough, LAnnAutomation::IsFontStrikeThrough, LAnnAutomation::SetFontItalic, LAnnAutomation::IsFontItalic, LAnnAutomation::SetFontBold, LAnnAutomation::IsFontBold, Class Members

Topics:

Annotation Functions: Object Properties

Example

This example gets and updates the property of the object

passed by the caller

L_INT LAnnAutomation_GetFontNameExample(LAnnAutomation  * pAnnObject)
{
   L_INT nRet;
   L_TCHAR  * pFontName; /* The object's font name */
   HGLOBAL hFontname; /* Handle for memory management */
   L_UINT NameLength;/* Length of the object's font name */
   /* Get the length of the current font name */
   NameLength = pAnnObject->GetFontNameLen();
   /* Allocate and lock a zero-filled buffer for the font name */
   hFontname = GlobalAlloc(GPTR,NameLength*sizeof(L_TCHAR));
   pFontName = (L_TCHAR  *)GlobalLock( hFontname );
   /* Get the current font name */
   nRet = pAnnObject->GetFontName(pFontName, &NameLength);
   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;
   }
   /* Free memory that we no longer need */
   GlobalFree(hFontname); 
   return SUCCESS;
}