Функция DrawTextWrap

  • Статья

[DrawTextWrap доступен в Windows XP с пакетом обновления 2 (SP2). В последующих версиях он может быть изменен или недоступен. Рекомендуется использовать DrawText напрямую.]

Рисует отформатированный текст в указанном прямоугольнике. Он форматирует текст в соответствии с указанным методом (расширение вкладок, обоснование символов, разрыв линий и т. д.). Эта функция заключает в оболочку вызов DrawText.

Синтаксис

int WINAPI DrawTextWrap(
  _In_    HDC              hdc,
  _Inout_ LPCTSTR          lpString,
  _In_    int              nCount,
  _Inout_ LPRECT           lpRect,
  _In_    UINT             uFormat,
  _In_    LPDRAWTEXTPARAMS lpDTParams
);

Параметры

hdc [in]

Тип: HDC

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

lpString [вход, выход]

Тип: LPCTSTR

Указатель на буфер, содержащий текст для рисования. Если параметр nCount имеет значение -1, строка должна быть завершена со значением NULL.

Если uFormat содержит DT_MODIFYSTRING, функция может добавить до четырех дополнительных символов в эту строку. Буфер, содержащий строку, должен быть достаточно большим, чтобы вместить эти дополнительные символы.

nCount [in]

Тип: int

Длина строки, на которую указывает lpString. Если значение nCount равно -1, то параметр lpString считается указателем на строку, завершающуюся null, и DrawText автоматически вычисляет число символов.

lpRect [вход, выход]

Тип: LPRECT

Указатель на структуру RECT , содержащую прямоугольник в логических координатах, в которых должен быть отформатирован текст.

uFormat [in]

Тип: UINT

Параметры форматирования. Полный список параметров см. в документации по DrawText .

lpDTParams [in]

Тип: LPDRAWTEXTPARAMS

Указатель на структуру DRAWTEXTPARAMS , которая задает дополнительные параметры форматирования. Этот параметр может принимать значение NULL.

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

Тип: int

Если функция выполнена успешно, возвращаемым значением будет высота текста в логических единицах. Если указан DT_VCENTER или DT_BOTTOM , возвращаемое значение представляет собой смещение от верхнего элемента lprc к нижней части нарисованного текста. Если функция завершается сбоем, возвращаемое значение равно нулю.

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

Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

DrawTextWrap не экспортируется по имени и не объявляется в общедоступном заголовке. Чтобы использовать его, необходимо использовать GetProcAddress и запросить порядковый номер 415 из ComCtl32.dll, чтобы получить указатель на функцию.

Дополнительные замечания см. в разделе DrawText.

Требования

Требование Значение
Минимальная версия клиента
 Windows Vista [только классические приложения]
Минимальная версия сервера
 Windows Server 2003 [только классические приложения]
DLL
Comctl32.dll (версия 6.0 или более поздняя)