IDWriteFactory::GetSystemFontCollection method

Gets an object which represents the set of installed fonts.

Syntax

HRESULT GetSystemFontCollection(
  IDWriteFontCollection **fontCollection,
  BOOL                  checkForUpdates
);

Parameters

fontCollection

Type: IDWriteFontCollection**

When this method returns, contains the address of a pointer to the system font collection object, or NULL in case of failure.

checkForUpdates

Type: BOOL

If this parameter is nonzero, the function performs an immediate check for changes to the set of installed 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 itself 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

   
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See Also

IDWriteFactory