IDWriteFontResource::GetAxisValueNames method (dwrite_3.h)

Article
11/20/2024

Retrieves the localized names of specific values for a font axis.

Syntax

HRESULT GetAxisValueNames(
        UINT32                  axisIndex,
        UINT32                  axisValueIndex,
  [out] DWRITE_FONT_AXIS_RANGE  *fontAxisRange,
  [out] IDWriteLocalizedStrings **names
);

Parameters

axisIndex

Type: UINT32

Font axis, from 0 to GetFontAxisCount minus 1.

axisValueIndex

Type: UINT32

Value index, from 0 to GetAxisValueNameCount minus 1.

[out] fontAxisRange

Type: DWRITE_FONT_AXIS_RANGE*

Range of the named value.

[out] names

Type: IDWriteLocalizedStrings**

The address of a pointer to an IDWriteLocalizedStrings interface. On successful completion, the function sets the pointer to a newly created localized strings object.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The font author may not have supplied names for some font axis values. The localized strings will be empty in that case. The range may be a single point, where minValue == maxValue. All ranges are in ascending order by axisValueIndex.

Requirements

Requirement	Value
Minimum supported client	Windows 10 Build 16299
Minimum supported server	Windows 10 Build 16299
Target Platform	Windows
Header	dwrite_3.h
Library	Dwrite.lib

Share via