IXpsOMGlyphsEditor::SetGlyphIndices method (xpsobjectmodel.h)

Article
02/22/2024

Sets an XPS_GLYPH_INDEX structure array that describes which glyph indices are to be used in the font.

Syntax

HRESULT SetGlyphIndices(
  [in] UINT32                indexCount,
  [in] const XPS_GLYPH_INDEX *glyphIndices
);

Parameters

[in] indexCount

The number of XPS_GLYPH_INDEX structures in the array that is referenced by glyphIndices. The value of 0 clears the property.

[in] glyphIndices

An array of XPS_GLYPH_INDEX structures that contain the glyph indices. If indexCount is 0, this parameter is ignored.

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_INVALIDARG	The index field of one or more XPS_GLYPH_INDEX structures has a value that is not valid. The index field must have a value between and including –1 and 65535 (0xFFFF).
E_POINTER	glyphIndices is NULL and indexCount is greater than 0.
XPS_E_INVALID_FLOAT	The advanceWidth, horizontalOffset, or verticalOffset field of one or more XPS_GLYPH_INDEX structures has a floating-point value that is not valid.
XPS_E_NEGATIVE_FLOAT	The advanceWidth field of one or more XPS_GLYPH_INDEX structures has a value that is not valid. The advanceWidth field must have a non-negative value or a value of exactly –1.0; a negative value that is not exactly –1.0 is not valid.

Remarks

The glyph indices that are passed in glyphIndices override the default cmap mapping from the UnicodeString property to the glyph index. Each XPS_GLYPH_INDEX structure also has advance width and 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