IXpsOMGlyphsEditor::GetGlyphMappings method (xpsobjectmodel.h)

Gets an array of XPS_GLYPH_MAPPING structures that describe how to map UTF-16 scalar values to entries in the array of XPS_GLYPH_INDEX structures, which is returned by GetGlyphIndices.

Syntax

HRESULT GetGlyphMappings(
  [in, out] UINT32            *glyphMappingCount,
  [out]     XPS_GLYPH_MAPPING *glyphMappings
);

Parameters

[in, out] glyphMappingCount

The number of XPS_GLYPH_MAPPING structures that will fit in the array referenced by glyphMappings. When the method returns, glyphMappingCount will contain the number of values in that array.

[out] glyphMappings

An array of XPS_GLYPH_MAPPING structures that receives the glyph mapping values.

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

Remarks

GetGlyphMappingCount gets the number of glyph mappings.

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

GetGlyphIndices

IXpsOMGlyphsEditor

XML Paper Specification

XPS Document Errors

XPS_GLYPH_MAPPING