Функция ScriptStringOut (usp10.h)

Статья
08/26/2023

Отображает строку, созданную при предыдущем вызове 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 или любое из следующих значений. Значения можно сочетать с двоичным ИЛИ.

Значение	Значение
ETO_CLIPPED	Обрезка текста по прямоугольнику.
ETO_OPAQUE	Используйте текущий цвет фона для заливки прямоугольника.

[in, optional] prc

Указатель на структуру RECT , которая определяет используемый прямоугольник. Если для параметра uOptions задано значение ETO_OPAQUE а для prcзадано значение NULL, функция выполняется успешно и возвращает S_OK. Однако если приложение задает для uOptions значение ETO_CLIPPING и предоставляет значение NULL для prc, функция возвращает E_INVALIDARG. Приложение может задать для этого параметра значение NULL , чтобы указать, что параметр не требуется.

[in] iMinSel

Отсчитываемый от нуля индекс, указывающий начальную позицию в строке. Если выбор не выбран, приложение должно установить iMinSel>= iMaxSel.

[in] iMaxSel

Отсчитываемый от нуля индекс, указывающий конечную позицию в строке.

[in] fDisabled

Значение TRUE , если операционная система применяет выделение отключенного текста, задав цвет фона COLOR_HIGHLIGHT за всеми выделенными символами. Приложение может задать для этого параметра значение FALSE, если операционная система применяет выделение с включенным текстом, задав цвет фона COLOR_HIGHLIGHT, а цвет текста — COLOR_HIGHLIGHTTEXT для каждого выбранного символа.

Возвращаемое значение

В случае успешного выполнения возвращает S_OK. Функция возвращает ненулевое значение HRESULT , если не удалось. Приложение не может проверить возвращаемое значение с помощью макросов SUCCEEDED и FAILED .

Приложение не должно использовать SetTextAlign с TA_UPDATECP при использовании ScriptStringOut , так как выделенный текст не может быть отрисован правильно. Если приложение должно использовать этот флаг, оно может отменить и сбросить флаг при необходимости, чтобы избежать проблемы.

Важно Начиная с Windows 8. Чтобы поддерживать возможность запуска в Windows 7, модуль, использующий Uniscribe, должен указать Usp10.lib перед gdi32.lib в списке библиотек.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	usp10.h
Библиотека	Usp10.lib
DLL	Usp10.dll

См. также раздел

SCRIPT_STRING_ANALYSIS

ScriptStringAnalyse

Одноимесяца

Функции uniscribe