DrawTextWrap 函数

  • 项目

[DrawTextWrap 可通过 Windows XP 使用 Service Pack 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 [in， out]

类型： LPCTSTR

指向包含要绘制的文本的缓冲区的指针。 如果 nCount 参数为 -1，则字符串必须以 null 结尾。

如果 uFormat 包含DT_MODIFYSTRING，则函数最多可为此字符串添加四个附加字符。 包含字符串的缓冲区应足够大，以容纳这些额外的字符。

nCount [in]

类型： int

lpString 指向的字符串的长度。 如果 nCount 为 -1，则 假定 lpString 参数是指向以 null 结尾的字符串的指针， DrawText 会自动计算字符计数。

lpRect [in， out]

类型： LPRECT

指向 RECT 结构的指针，该结构包含要设置文本格式的逻辑坐标矩形。

uFormat [in]

类型： UINT

格式设置选项。 有关选项的完整列表，请参阅 DrawText 文档。

lpDTParams [in]

类型： LPDRAWTEXTPARAMS

指向 DRAWTEXTPARAMS 结构的指针，该结构指定其他格式设置选项。 此参数可以为 NULL。

返回值

类型： int

如果函数成功，则返回值是文本高度（以逻辑单位为单位）。 如果指定了DT_VCENTER或DT_BOTTOM，则返回值为从 lprc的顶部成员到所绘制文本底部的偏移量，如果函数失败，则返回值为零。

如果函数失败，则返回值为零。

要获得更多的错误信息，请调用 GetLastError。

备注

DrawTextWrap 不会按名称导出或在公共标头中声明。 若要使用它，必须使用 GetProcAddress 并从 ComCtl32.dll 请求序号 415 来获取函数指针。

有关其他说明，请参阅 DrawText。

要求

要求 值
最低受支持的客户端
 Windows Vista [仅限桌面应用]
最低受支持的服务器
 Windows Server 2003 [仅限桌面应用]
DLL
Comctl32.dll (版本 6.0 或更高版本)