GetThemeFont function

Retrieves the value of a font property.

Syntax

THEMEAPI GetThemeFont(
  HTHEME   hTheme,
  HDC      hdc,
  int      iPartId,
  int      iStateId,
  int      iPropId,
  LOGFONTW *pFont
);

Parameters

hTheme

Type: HTHEME

Handle to a window's specified theme data. Use OpenThemeData to create an HTHEME.

hdc

Type: HDC

HDC. This parameter may be set to NULL.

iPartId

Type: int

Value of type int that specifies the part that contains the font property. See Parts and States.

iStateId

Type: int

Value of type int that specifies the state of the part. See Parts and States.

iPropId

Type: int

Value of type int that specifies the property to retrieve. For a list of possible values, see Property Identifiers.

pFont

Type: LOGFONTW*

Pointer to a LOGFONT structure that receives the font property value.

Return Value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The font is scaled in dots per inch (DPI) for the current logical screen.

If the property is not supported for the specified part and state, E_PROP_ID_UNSUPPORTED may be returned.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header uxtheme.h
Library UxTheme.lib
DLL UxTheme.dll

See Also

Property Identifiers