ScriptString_pcOutChars

The ScriptString_pcOutChars function returns a pointer to the length of a string after clipping.

const int* WINAPI ScriptString_pcOutChars(
  SCRIPT_STRING_ANALYSIS ssa 
);

Parameters

ssa

[in] A SCRIPT_STRING_ANALYSIS structure for the string.

Return Values

If the function is successful, it returns a pointer to the length of the string after clipping. The length is the number of Unicode code points.

If the function fails, it returns NULL. 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.

Remarks

Clipping requires that SSA_CLIP was requested in the original call to ScriptStringAnalyse.

Note, the INT pointer is valid only until the associated ssa is passed to ScriptStringFree.

Requirements

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

See Also

Uniscribe Overview, Uniscribe Functions, ScriptStringAnalyse, ScriptStringFree, SCRIPT_STRING_ANALYSIS