ScriptGetCMap function

Retrieves the glyph indexes of the Unicode characters in a string according to either the TrueType cmap table or the standard cmap table implemented for old-style fonts.

Syntax

HRESULT ScriptGetCMap(
  _In_          HDC          hdc,
  _Inout_       SCRIPT_CACHE *psc,
  _In_    const WCHAR        *pwcInChars,
  _In_          int          cChars,
  _In_          DWORD        dwFlags,
  _Out_         WORD         *pwOutGlyphs
);

Parameters

hdc [in]

Optional. Handle to the device context. For more information, see Caching.

psc [in, out]

Pointer to a SCRIPT_CACHE structure identifying the script cache.

pwcInChars [in]

Pointer to a string of Unicode characters.

cChars [in]

Number of Unicode characters in the string indicated by pwcInChars.

dwFlags [in]

Flags specifying any special handling of the glyphs. By default, the glyphs are provided in logical order with no special handling. This parameter can have the following value.

Value	Meaning
SGCM_RTL	The glyph array indicated by pwOutGlyphs should contain mirrored glyphs for those glyphs that have a mirrored equivalent.

 

pwOutGlyphs [out]

Pointer to a buffer in which the function retrieves an array of glyph indexes. This buffer should be of the same length as the input buffer indicated by pwcInChars. Each code point maps to a single glyph.

Return value

Returns S_OK if all Unicode code points are present in the font. The function returns one of the nonzero HRESULT values listed below if it does not succeed.

Remarks

See Displaying Text with Uniscribe for a discussion of the context in which this function is normally called.

This function can be used to determine the characters in a run that are supported by the selected font. The application can scan the retrieved glyph buffer, looking for the default glyph to determine characters that are not available. The application should determine the default glyph index for the selected font by calling ScriptGetFontProperties.

The return value for this function indicates the presence of any missing glyphs.

Some code points can be rendered by a combination of glyphs, as well as by a single glyph, for example, 00C9; LATIN CAPITAL LETTER E WITH ACUTE. In this case, if the font supports the capital E glyph and the acute glyph, but not a single glyph for 00C9, ScriptGetCMap shows that 00C9 is unsupported. To determine the font support for a string that contains these kinds of code points, the application can call ScriptShape. If the function returns S_OK, the application should check the output for missing glyphs.

Requirements

See also

Uniscribe

Uniscribe Functions

Displaying Text with Uniscribe

ScriptGetFontProperties

ScriptShape

SCRIPT_CACHE