IDWriteFontFamily1::GetFontLocality method (dwrite_3.h)

Gets the current location of a font given its zero-based index.

Syntax

DWRITE_LOCALITY GetFontLocality(
  [in] UINT32 listIndex
);

Parameters

[in] listIndex

Type: UINT32

Zero-based index of the font in the font list.

Return value

Type: DWRITE_LOCALITY

Returns a DWRITE_LOCALITY-typed value that specifies the location of the specified font.

Remarks

For fully local files, the result will always be DWRITE_LOCALITY_LOCAL. For streamed files, the result depends on how much of the file has been downloaded. GetFont fails if the locality is DWRITE_LOCALITY_REMOTE and potentially fails if DWRITE_LOCALITY_PARTIAL.

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

IDWriteFontFamily1