Edit

FontFamilyFunctions

  • Article

Windows GDI+ exposes a flat API that consists of about 600 functions, which are implemented in Gdiplus.dll and declared in Gdiplusflat.h. The functions in the GDI+ flat API are wrapped by a collection of about 40 C++ classes. It is recommended that you do not directly call the functions in the flat API. Whenever you make calls to GDI+, you should do so by calling the methods and functions provided by the C++ wrappers. Microsoft Product Support Services will not provide support for code that calls the flat API directly. For more information on using these wrapper methods, see GDI+ Flat API.

The following flat API functions are wrapped by the FontFamily C++ class.

FontFamily Functions and Corresponding Wrapper Methods

Flat function Wrapper method Remarks
GpStatus WINGDIPAPI GdipDeleteFontFamily(GpFontFamily *fontFamily)
 FontFamily::~FontFamily.
 Releases the GpFontFamily created by the GdipCreateFontFamilyFromName API.
GpStatus WINGDIPAPI GdipCloneFontFamily(GpFontFamily *fontFamily, GpFontFamily **clonedFontFamily)
 Not called by wrapper methods.
 Not implemented.
GpStatus WINGDIPAPI GdipCreateFontFamilyFromName(GDIPCONST WCHAR *name, GpFontCollection *fontCollection, GpFontFamily **FontFamily)
 FontFamily::FontFamily( IN const WCHAR* name, IN const FontCollection* fontCollection ) Creates a FontFamily::FontFamily object based on a specified font family.
GpStatus WINGDIPAPI GdipCloneFontFamily(GpFontFamily *FontFamily, GpFontFamily **clonedFontFamily)
 FontFamily* FontFamily::Clone() Creates a new FontFamily::FontFamily object based on this FontFamily::FontFamily object.
GpStatus WINGDIPAPI GdipGetGenericFontFamilySansSerif(GpFontFamily **nativeFamily)
 FontFamily * FontFamily::GenericSansSerif() Gets a FontFamily::FontFamily object that specifies a generic sans serif typeface.
GpStatus WINGDIPAPI GdipGetGenericFontFamilySerif(GpFontFamily **nativeFamily)
 const FontFamily * FontFamily::GenericSerif() Gets a FontFamily::FontFamily object that specifies a generic serif typeface.
GpStatus WINGDIPAPI GdipGetGenericFontFamilyMonospace(GpFontFamily **nativeFamily)
 const FontFamily * FontFamily::GenericMonospace() Gets a FontFamily::FontFamily object that specifies a generic monospace typeface.
GpStatus WINGDIPAPI GdipGetFamilyName( GDIPCONST GpFontFamily *family, WCHAR name[LF_FACESIZE], LANGID language )
 Status FontFamily::GetFamilyName( IN WCHAR name[LF_FACESIZE], IN LANGID language ) const Gets the name of this font family.
GpStatus WINGDIPAPI GdipIsStyleAvailable(GDIPCONST GpFontFamily *family, INT style, BOOL * IsStyleAvailable)
 BOOL FontFamily::IsStyleAvailable(IN INT style) const Determines whether the specified style is available for this font family.
GpStatus WINGDIPAPI GdipFontCollectionEnumerable( GpFontCollection* fontCollection, GpGraphics* graphics, INT * numFound )
 Not called by wrapper methods.
 Not implemented
GpStatus WINGDIPAPI GdipFontCollectionEnumerate( GpFontCollection* fontCollection, INT numSought, GpFontFamily* gpfamilies[], INT* numFound, GpGraphics* graphics )
 Not called by wrapper methods.
 Not implemented
GpStatus WINGDIPAPI GdipGetEmHeight(GDIPCONST GpFontFamily *family, INT style, UINT16 * EmHeight)
 UINT16 FontFamily::GetEmHeight(IN INT style) const Gets the size (commonly called em size or em height), in design units, of this font family.
GpStatus WINGDIPAPI GdipGetCellAscent(GDIPCONST GpFontFamily *family, INT style, UINT16 * CellAscent)
 UINT16 FontFamily::GetCellAscent(IN INT style) const Gets the cell ascent, in design units, of this font family for the specified style or style combination.
GpStatus WINGDIPAPI GdipGetCellDescent(GDIPCONST GpFontFamily *family, INT style, UINT16 * CellDescent)
 UINT16 FontFamily::GetCellDescent(IN INT style) const Gets the cell descent, in design units, of this font family for the specified style or style combination.
GpStatus WINGDIPAPI GdipGetLineSpacing(GDIPCONST GpFontFamily *family, INT style, UINT16 * LineSpacing)
 UINT16 FontFamily::GetLineSpacing(IN INT style) const Gets the line spacing, in design units, of this font family for the specified style or style combination. The line spacing is the vertical distance between the base lines of two consecutive lines of text.