scriptStringOut 函数 (usp10.h)

  • 项目

显示先前调用 ScriptStringAnalyse 生成的字符串，并选择性地添加突出显示。

语法

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

参数

[in] ssa

字符串 的SCRIPT_STRING_ANALYSIS 结构。

[in] iX

用于定位字符串的参考点的 x 坐标。

[in] iY

用于定位字符串的参考点的 y 坐标。

[in] uOptions

指定使用应用程序定义的矩形的选项。 此参数可以设置为 0 或以下任何值。 这些值可以与二进制 OR 组合使用。

值 含义
ETO_CLIPPED
 将文本剪裁到矩形。
ETO_OPAQUE
 使用当前背景色填充矩形。

[in, optional] prc

指向定义要使用的矩形的 RECT 结构的指针。 如果 uOptions 设置为 ETO_OPAQUE并为 prc 提供 NULL，则该函数成功并返回S_OK。 但是，如果应用程序将 uOptions 设置为 ETO_CLIPPING并为 prc 提供 NULL，则该函数将返回E_INVALIDARG。 应用程序可以将此参数设置为 NULL ，以指示不需要任何选项。

[in] iMinSel

从零开始的索引，指定字符串中的起始位置。 如果没有选择，应用程序应设置 iMinSel>= iMaxSel。

[in] iMaxSel

从零开始的索引，指定字符串中的结束位置。

[in] fDisabled

如果操作系统通过将背景色设置为在所有选定字符后面COLOR_HIGHLIGHT来应用禁用文本突出显示，则为 TRUE。 如果操作系统通过将背景色设置为COLOR_HIGHLIGHT并将文本颜色设置为每个选定字符COLOR_HIGHLIGHTTEXT来应用启用的文本突出显示，则应用程序可以将此参数设置为 FALSE 。

返回值

如果成功，则返回S_OK。 如果函数不成功，则返回非零 HRESULT 值。 应用程序无法使用 SUCCEEDED 和 FAILED 宏测试返回值。

注解

若要使用此函数，应用程序需要在对 ScriptStringAnalyse 的原始调用中指定SSA_GLYPHS。

使用 ScriptStringOut 时，应用程序不应将 SetTextAlign 与 TA_UPDATECP 一起使用，因为无法正确呈现所选文本。 如果应用程序必须使用此标志，它可以根据需要取消设置和重置标志以避免此问题。

重要从 Windows 8 开始：若要保持在 Windows 7 上运行的能力，使用 Uniscribe 的模块必须在其库列表中指定 gdi32.lib 之前的 Usp10.lib。
 

要求

要求 值
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 usp10.h
Library Usp10.lib
DLL Usp10.dll

另请参阅

SCRIPT_STRING_ANALYSIS

ScriptStringAnalyse

Uniscribe

Uniscribe 函数