Edit

Share via

IDWriteFactory::CreateCustomFontCollection method (dwrite.h)

  • Article

Creates a font collection using a custom font collection loader.

Syntax

HRESULT CreateCustomFontCollection(
        IDWriteFontCollectionLoader *collectionLoader,
  [in]  void const                  *collectionKey,
        UINT32                      collectionKeySize,
  [out] IDWriteFontCollection       **fontCollection
);

Parameters

collectionLoader

Type: IDWriteFontCollectionLoader*

An application-defined font collection loader, which must have been previously registered using RegisterFontCollectionLoader.

[in] collectionKey

Type: const void*

The key used by the loader to identify a collection of font files. The buffer allocated for this key should at least be the size of collectionKeySize.

collectionKeySize

Type: UINT32

The size, in bytes, of the collection key.

[out] fontCollection

Type: IDWriteFontCollection**

Contains an address of a pointer to the system font collection object if the method succeeds, or NULL in case of failure.

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 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