ScriptStringGetOrder function

Creates an array that maps an original character position to a glyph position.

Syntax


HRESULT ScriptStringGetOrder(
  _In_   SCRIPT_STRING_ANALYSIS ssa,
  _Out_  UINT *puOrder
);

Parameters

ssa [in]

A SCRIPT_STRING_ANALYSIS structure for the string.

puOrder [out]

Pointer to a buffer in which this function retrieves an array of glyph positions, indexed by the original character position. The array should have room for at least the number of integers indicated by the ssa parameter of ScriptString_pcOutChars.

Return value

Returns S_OK if successful. The function returns a nonzero HRESULT value if it does not succeed. The application can test the return value with the SUCCEEDED and FAILED macros.

Remarks

When the number of glyphs and the number of characters are equal, the function retrieves an array that references every glyph. This is the same treatment that occurs in GetCharacterPlacement.

To use this function, the application needs to specify SSA_GLYPHS in its original call to ScriptStringAnalyse.

Important  Starting with Windows 8: To maintain the ability to run on Windows 7, a module that uses Uniscribe must specify Usp10.lib before gdi32.lib in its library list.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

Internet Explorer 5 or later on Windows Me/98/95

Header

Usp10.h

Library

Usp10.lib

DLL

Usp10.dll

See also

Uniscribe
Uniscribe Functions
ScriptStringAnalyse
ScriptString_pcOutChars
SCRIPT_STRING_ANALYSIS

 

 

Community Additions

ADD
Show:
© 2014 Microsoft