Функция TabbedTextOutA (winuser.h)

Статья
11/20/2024

Функция TabbedTextOut записывает символьную строку в указанном расположении, расширяя вкладки до значений, указанных в массиве позиций табуляции. Текст записывается в выбранный в данный момент шрифт, цвет фона и цвет текста.

Синтаксис

LONG TabbedTextOutA(
  [in] HDC       hdc,
  [in] int       x,
  [in] int       y,
  [in] LPCSTR    lpString,
  [in] int       chCount,
  [in] int       nTabPositions,
  [in] const INT *lpnTabStopPositions,
  [in] int       nTabOrigin
);

Параметры

[in] hdc

Дескриптор контекста устройства.

[in] x

Координата x начальной точки строки в логических единицах.

[in] y

Координата y начальной точки строки в логических единицах.

[in] lpString

Указатель на строку символа для рисования. Строка не должна быть завершена с нуля, так как nCount указывает длину строки.

[in] chCount

Длина строки, на которую указывает lpString.

[in] nTabPositions

Количество значений в массиве позиций табуляции стоп.

[in] lpnTabStopPositions

Указатель на массив, содержащий позиции табуляции в логических единицах. Остановки табуляции должны быть отсортированы по возрастанию порядка; Наименьшее x-значение должно быть первым элементом в массиве.

[in] nTabOrigin

Координата x начальной позиции, с которой разворачиваются вкладки, в логических единицах.

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

Если функция выполнена успешно, возвращаемое значение является измерениями в логических единицах строки. Высота находится в слове высокого порядка и ширина находится в слове с низким порядком.

Если функция завершается ошибкой, возвращаемое значение равно нулю.

Замечания

Если параметр nTabPositions , а параметр lpnTabStopPositions равен NULL, вкладки расширяются до восьми раз средней ширины символов.

Если nTabPositions равно 1, точка вкладки отделяется расстоянием, указанным первым значением в массиве lpnTabStopPositions.

Если массив lpnTabStopPositions содержит несколько значений, то для каждого значения в массиве устанавливается остановка табуляции до числа, указанного nTabPositions.

Параметр nTabOrigin позволяет приложению вызывать функцию TabbedTextOut несколько раз для одной строки. Если приложение вызывает TabbedTextOut более одного раза с nTabOrigin, то функция развертывает все вкладки относительно позиции, указанной nTabOrigin.

По умолчанию текущая позиция не используется или обновляется функцией TabbedTextOut. Если приложению необходимо обновить текущую позицию при вызове TabbedTextOut, приложение может вызвать функцию SetTextAlign с параметром wFlags, заданным для TA_UPDATECP. Если этот флаг задан, система игнорирует параметры X и Y при последующих вызовах функции TabbedTextOut, используя текущую позицию.

примечание для Windows Vista и более поздних версий TabbedTextOut игнорирует выравнивание текста при рисовании текста.

Заметка

Заголовок winuser.h определяет TabbedTextOut как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-misc-l1-5-1 (представлено в Windows 10 версии 10.0.14393)