ScriptStringGetLogicalWidths

The ScriptStringGetLogicalWidths function converts visual widths into logical widths.

HRESULT WINAPI ScriptStringGetLogicalWidths(
  SCRIPT_STRING_ANALYSIS ssa, 
  int *piDx 
);

Parameters

ssa

[in] A SCRIPT_STRING_ANALYSIS structure for the string.

piDx

[out] Pointer to a buffer containing the logical widths that are returned. The buffer should have room for at least *ScriptString_pcOutChars(ssa) ints.

Return Values

If the function is successful, it returns S_OK.

If the function fails, it returns another HRESULT value. And if any other unrecoverable error is encountered, it is also returned as HRESULT. For example, error returns from Win32 API functions are converted to HRESULT using the HRESULT_FROM_WIN32 macro and returned to the client in the HRESULT.

The return value can be tested with the SUCCEEDED and FAILED macros.

Remarks

This function converts the visual widths that were generated by ScriptStringAnalyse into logical widths, one per original character, in logical order.

This function requires that SSA_GLYPHS was requested in the original ScriptStringAnalyse call.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Usp10.h.
  Library: Use Usp10.lib.

See Also

Uniscribe Overview, Uniscribe Functions, ScriptStringAnalyse, ScriptString_pcOutChars, SCRIPT_STRING_ANALYSIS