IDWriteFontFamily::GetMatchingFonts method (dwrite.h)

Gets a list of fonts in the font family ranked in order of how well they match the specified properties.

Syntax

HRESULT GetMatchingFonts(
        DWRITE_FONT_WEIGHT  weight,
        DWRITE_FONT_STRETCH stretch,
        DWRITE_FONT_STYLE   style,
  [out] IDWriteFontList     **matchingFonts
);

Parameters

weight

Type: DWRITE_FONT_WEIGHT

A value that is used to match a requested font weight.

stretch

Type: DWRITE_FONT_STRETCH

A value that is used to match a requested font stretch.

style

Type: DWRITE_FONT_STYLE

A value that is used to match a requested font style.

[out] matchingFonts

Type: IDWriteFontList**

An address of a pointer to the newly created IDWriteFontList object.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteFontFamily