Edit

IDWriteFontSet1::GetFilteredFonts(DWRITE_FONT_AXIS_RANGEconst*,UINT32,BOOL,IDWriteFontSet1**) method (dwrite_3.h)

  • Article

Retrieves a subset of fonts filtered by the given ranges, endpoint-inclusive.

Syntax

HRESULT GetFilteredFonts(
        DWRITE_FONT_AXIS_RANGE const *fontAxisRanges,
        UINT32                       fontAxisRangeCount,
        BOOL                         selectAnyRange,
  [out] IDWriteFontSet1              **filteredFontSet
);

Parameters

fontAxisRanges

Type: DWRITE_FONT_AXIS_RANGE const *

List of axis value ranges to filter by.

fontAxisRangeCount

Type: UINT32

The number of axis value ranges to filter.

selectAnyRange

Type: BOOL

true if GetFilteredFonts should select any range; false if it should select the intersection of them all.

[out] filteredFontSet

Type: IDWriteFontSet1**

The address of a pointer to an IDWriteFontSet1 interface. On successful completion, the function sets the pointer to an object representing the subset of fonts that fall within the ranges, otherwise it sets the pointer to nullptr.

Return value

Type: HRESULT

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

Remarks

If no fonts match the filter, then the returned subset object will be empty (calling IDWriteFontSet::GetFontCount on it returns 0), but the function does not return an error. The subset is always equal to or less than the original set.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Minimum supported server Windows 10 Build 20348
Target Platform Windows
Header dwrite_3.h
Library Dwrite.lib