Edit

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

  • Article

Retrieves a subset of fonts, filtered by the given indices.

Syntax

HRESULT GetFilteredFonts(
        UINT32 const    *indices,
        UINT32          indexCount,
  [out] IDWriteFontSet1 **filteredFontSet
);

Parameters

indices

Type: UINT32 const *

An array of indices to filter by, in the range 0 to IDwriteFontSet::GetFontCount minus 1.

indexCount

Type: UINT32

The number of indices.

[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 indicated by the given indices, 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

The indices can come in any order, meaning that GetFilteredFonts can produce a new set with items removed, duplicated, or reordered from the original. If you pass zero indices, then an empty font set is returned.

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