IXpsOMGlyphs::GetFontFaceIndex method (xpsobjectmodel.h)

Article
02/22/2024

Gets the index of the font face to be used.

This value is only used when GetFontResource returns an IXpsOMFontResource interface that represents a TrueType font collection.

Syntax

HRESULT GetFontFaceIndex(
  [out, retval] SHORT *fontFaceIndex
);

Parameters

[out, retval] fontFaceIndex

The index value of the font face. If the font face has not been set, –1 is returned.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	fontFaceIndex is NULL.

Remarks

The font resource is obtained by calling the GetFontResource method.

If a font face has not been set or is not supported by the font, a value of –1 is returned in fontFaceIndex. When the glyph is loaded from an existing XPS document file, a fontFaceIndex value of –1 indicates that the FontUri attribute did not include a #index fragment.

In the following markup of a FixedPage, the FontUri attribute of the Glyphs element has a value of ../Resources/Fonts/Font.TTF#1. In this case, GetFontFaceIndex would return a value of 1 in fontFaceIndex.

    &lt;FixedPage Height="1056" Width="816" xml:lang="en-US"
    xmlns="http://schemas.microsoft.com/xps/2005/06"&gt;
      &lt;Glyphs
      OriginX="96"
      OriginY="96"
      UnicodeString="This is Page 1!"
      FontUri="../Resources/Fonts/Font.TTF#1"
      FontRenderingEmSize="16" /&gt;
    &lt;/FixedPage&gt;

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	xpsobjectmodel.h