IDWriteFactory7::GetSystemFontCollection method (dwrite_3.h)

  • Article

Retrieves a collection of fonts, grouped into families.

Syntax

HRESULT GetSystemFontCollection(
        BOOL                     includeDownloadableFonts,
        DWRITE_FONT_FAMILY_MODEL fontFamilyModel,
  [out] IDWriteFontCollection3   **fontCollection
);

Parameters

includeDownloadableFonts

Type: BOOL

true if you want to include downloadable fonts. false if you only want locally installed fonts.

fontFamilyModel

Type: DWRITE_FONT_FAMILY_MODEL

How to group families in the collection.

[out] fontCollection

Type: IDWriteFontCollection3**

The address of a pointer to an IDWriteFontCollection3 interface. On successful completion, the function sets the pointer to a newly created font collection object, 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.

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