IXpsOMGlyphs::GetGlyphIndices method (xpsobjectmodel.h)

Article
07/27/2022

Gets an array of XPS_GLYPH_INDEX structures that describe the specific glyph indices in the font.

Syntax

HRESULT GetGlyphIndices(
  [in, out] UINT32          *indexCount,
  [in, out] XPS_GLYPH_INDEX *glyphIndices
);

Parameters

[in, out] indexCount

The number of XPS_GLYPH_INDEX structures that will fit in the array that is referenced by glyphIndices. When the method returns, indexCount will contain the number of XPS_GLYPH_INDEX structures that are returned in the array referenced by glyphIndices.

[in, out] glyphIndices

The address of an array of XPS_GLYPH_INDEX structures that receive the glyph indices.

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	indexCount or glyphIndices is NULL.
ERROR_MORE_DATA	glyphIndices is not large enough to receive the glyph index data. indexCount contains the required number of elements.

Remarks

GetGlyphIndexCount gets the number of elements in the glyph index array.

The glyph indices override the default cmap mapping from the UnicodeString to the glyph index. The XPS_GLYPH_INDEX structure also contains advance width as well as vertical and horizontal offset information.

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