IDWriteFontCollectionLoader::CreateEnumeratorFromKey method

Creates a font file enumerator object that encapsulates a collection of font files. The font system calls back to this interface to create a font collection.

Syntax

HRESULT CreateEnumeratorFromKey(
  IDWriteFactory            *factory,
  void const                *collectionKey,
  UINT32                    collectionKeySize,
  IDWriteFontFileEnumerator **fontFileEnumerator
);

Parameters

factory

Type: IDWriteFactory*

Pointer to the IDWriteFactory object that was used to create the current font collection.

collectionKey

Type: const void*

A font collection key that uniquely identifies the collection of font files within the scope of the font collection loader being used. The buffer allocated for this key must be at least the size, in bytes, specified by collectionKeySize.

collectionKeySize

Type: UINT32

The size of the font collection key, in bytes.

fontFileEnumerator

Type: IDWriteFontFileEnumerator**

When this method returns, contains the address of a pointer to the newly created font file enumerator.

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

IDWriteFontCollectionLoader