IDWriteFontSet::GetPropertyValues(DWRITE_FONT_PROPERTY_ID,WCHARconst*,IDWriteStringList**) method (dwrite_3.h)

Returns all unique property values in the set, which can be used for purposes such as displaying a family list or tag cloud. Values are returned in priority order according to the language list, such that if a font contains more than one localized name, then the preferred one is returned.

Syntax

HRESULT GetPropertyValues(
  DWRITE_FONT_PROPERTY_ID propertyID,
  WCHAR const             *preferredLocaleNames,
  IDWriteStringList       **values
);

Parameters

propertyID

Type: DWRITE_FONT_PROPERTY_ID

Font property of interest.

preferredLocaleNames

Type: WCHAR const *

The preferred locale names to query as a list of semicolon-delimited names in preferred order. When a particular string (such as font family) has more than one localized name, then the first match is returned. If the first match doesn't exist, then the second match is returned, and so on. For example, "ja-jp;en-us".

values

Type: [out] IDWriteLocalizedStrings**

Receives a pointer to the newly created localized strings object; or nullptr on failure or non-existent property.

Return value

Type: HRESULT

If this method succeeds, then 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

IDWriteFontSet