Edit

Share via

IDWriteFactory3::GetSystemFontCollection method (dwrite_3.h)

  • Article

Retrieves a weight/width/slope tree of system fonts.

Syntax

HRESULT GetSystemFontCollection(
  BOOL                   includeDownloadableFonts,
  IDWriteFontCollection1 **fontCollection,
  BOOL                   checkForUpdates
);

Parameters

includeDownloadableFonts

Type: BOOL

Indicates whether to include cloud fonts or only locally installed fonts.

fontCollection

Type: IDWriteFontCollection1**

Holds the newly created font collection object, or NULL in case of failure.

checkForUpdates

Type: BOOL

If this parameter is TRUE, the function performs an immediate check for changes
to the set of system fonts. If this parameter is FALSE, the function will still detect changes if the font
cache service is running, but there may be some latency. For example, an application might specify TRUE if
it has just installed a font and wants to be sure the font collection contains that font.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header dwrite_3.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteFactory3