FontFamily::GetFamilyName method (gdiplusheaders.h)
The FontFamily::GetFamilyName method gets the name of this font family.
Syntax
Status GetFamilyName(
[out] LPWSTR name,
[in] LANGID language
);
Parameters
[out] name
Type: WCHAR[LF_FACESIZE]
Name of this font family.
[in] language
Type: WCHAR
Optional. Sixteen-bit value that specifies the language to use. The default value is LANG_NEUTRAL, which is the user's default language.
Return value
Type: Status
If the method succeeds, it returns Ok, which is an element of the Status enumeration.
If the method fails, it returns one of the other elements of the Status enumeration.
Remarks
When specifying LANG_NEUTRAL as the language ID, it is common practice to pass just LANG_NEUTRAL as in the following example:
stat = FontFamily.GetFamilyName(name, LANG_NEUTRAL);
If you are specifying a language other than LANG_NEUTRAL, use MAKELANGID to create the language and sublanguage combination as in the following example:
LANGID language = MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL);
For a listing of the available languages and sublanguages, see Winnt.h.
Examples
The following example creates a FontFamily object, gets the family name, and outputs the name as text.
VOID Example_GetFamilyName(HDC hdc)
{
Graphics graphics(hdc);
// Create a FontFamily object.
FontFamily nameFontFamily(L"arial");
// Get the cell ascent of the font family in design units.
WCHAR familyName[LF_FACESIZE];
nameFontFamily.GetFamilyName(familyName);
// Copy the cell ascent into a string and draw the string.
SolidBrush solidbrush(Color(255, 0, 0, 0));
Font font(&nameFontFamily, 16);
graphics.DrawString(familyName, -1, &font, PointF(0, 0), &solidbrush);
}
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP, Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | gdiplusheaders.h (include Gdiplus.h) |
| Library | Gdiplus.lib |
| DLL | Gdiplus.dll |