Edit

IXpsOMGlyphsEditor::SetGlyphMappings method (xpsobjectmodel.h)

  • Article

Sets an array of XPS_GLYPH_MAPPING structures that describe how to map the UTF-16 scalar values in the UnicodeString property to entries in the array of XPS_GLYPH_INDEX structures.

Syntax

HRESULT SetGlyphMappings(
  [in] UINT32                  glyphMappingCount,
  [in] const XPS_GLYPH_MAPPING *glyphMappings
);

Parameters

[in] glyphMappingCount

The number of XPS_GLYPH_MAPPING structures in the array that is referenced by glyphMappings. A value of 0 clears the property.

[in] glyphMappings

An XPS_GLYPH_MAPPING structure array that contains the glyph mapping values. If glyphMappingCount is 0, this parameter is ignored and can be set to NULL.

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
 A member of one or more XPS_GLYPH_MAPPING structures has a value that is not valid. This can occur in the following cases: the sum of string length and start position is less than the start position; the sum of index position and index length is less than the start position; and length of indices is 0.
E_POINTER
 glyphMappings is NULL and glyphMappingCount is greater than 0.
XPS_E_MAPPING_OUT_OF_ORDER
 In one or more XPS_GLYPH_MAPPING structures, an element is out of sequence.

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

See also

IXpsOMGlyphsEditor

XML Paper Specification

XPS Document Errors

XPS_GLYPH_MAPPING