Функция DrawTextExPrivWrap

  • Статья

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

Рисует отформатированный текст в указанном прямоугольнике. Эта функция заключает в оболочку вызов DrawTextEx.

Синтаксис

int WINAPI DrawTextExPrivWrap(
  _In_    HDC              hdc,
  _Inout_ LPTSTR           lpchText,
  _In_    int              cchText,
  _Inout_ LPRECT           lprc,
  _In_    UINT             dwDTFormat,
  _In_    LPDRAWTEXTPARAMS lpDTParams
);

Параметры

hdc [in]

Тип: HDC

Дескриптор контекста устройства, в котором выполняется рисование.

lpchText [in, out]

Тип: LPTSTR

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

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

cchText [in]

Тип: int

Длина строки, на которую указывает lpchText. Если cchText имеет значение -1, то параметр lpchText считается указателем на строку, завершаемую null, и DrawTextEx автоматически вычисляет число символов.

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

Тип: LPRECT

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

dwDTFormat [in]

Тип: UINT

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

lpDTParams [in]

Тип: LPDRAWTEXTPARAMS

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

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

Тип: int

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

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

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

Комментарии

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

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

Требования

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