ScriptStringOut

The ScriptStringOut function displays a string generated by a prior call to ScriptStringAnalyse and optionally adds highlighting.

HRESULT WINAPI ScriptStringOut(
  SCRIPT_STRING_ANALYSIS ssa, 
  int iX, 
  int iY, 
  UINT uOptions, 
  const RECT *prc, 
  int iMinSel, 
  int iMaxSel, 
  BOOL fDisabled 
);

Parameters

ssa

[in] A SCRIPT_STRING_ANALYSIS structure for the string.

iX

[in] Specifies the x-coordinate of the reference point used to position the string.

iY

[in] Specifies the y-coordinate of the reference point used to position the string.

uOptions

[in] Specifies how to use the application-defined rectangle. This parameter can be a combination of the following values.

Value	Meaning
ETO_CLIPPED	The text will be clipped to the rectangle.
ETO_OPAQUE	The current background color should be used to fill the rectangle.

prc

[in] Pointer to a RECT structure that defines a clipping rectangle. The puOptions parameter must be set to ETO_CLIPPED.

iMinSel

[in] Starting position in the string. For no selection, set iMinSel >= iMaxSel.

iMaxSel

[in] Ending position in the string.

fDisabled

[in] If this parameter is TRUE, the system applies disabled-text highlighting by setting the background color to COLOR_HIGHLIGHT behind all selected characters.

If this parameter is FALSE, the system applies enabled-text highlighting by setting the background color to COLOR_HIGHLIGHT and the text color to COLOR_HIGHLIGHTTEXT for each selected character.

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 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, RECT, SCRIPT_STRING_ANALYSIS