Função DrawTextWrap

  • Artigo

[DrawTextWrap está disponível por meio do Windows XP com Service Pack 2 (SP2). Ele pode estar alterado ou indisponível em versões subsequentes. Em vez disso, é recomendável usar DrawText diretamente.]

Desenha texto formatado no retângulo especificado. Ele formata o texto de acordo com o método especificado (expandindo guias, justificando caracteres, linhas de quebra e assim por diante). Essa função encapsula uma chamada para DrawText.

Sintaxe

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

Parâmetros

hdc [in]

Tipo: HDC

Um identificador para o contexto do dispositivo.

lpString [in, out]

Tipo: LPCTSTR

Um ponteiro para um buffer que contém o texto a ser desenhado. Se o parâmetro nCount for -1, a cadeia de caracteres deverá ser terminada em nulo.

Se uFormat incluir DT_MODIFYSTRING, a função poderá adicionar até quatro caracteres adicionais a essa cadeia de caracteres. O buffer que contém a cadeia de caracteres deve ser grande o suficiente para acomodar esses caracteres extras.

nCount [in]

Tipo: int

O comprimento da cadeia de caracteres apontada por lpString. Se nCount for -1, o parâmetro lpString será considerado um ponteiro para uma cadeia de caracteres terminada em nulo e DrawText calculará a contagem de caracteres automaticamente.

lpRect [in, out]

Tipo: LPRECT

Um ponteiro para uma estrutura RECT que contém o retângulo, em coordenadas lógicas, em que o texto deve ser formatado.

uFormat [in]

Tipo: UINT

As opções de formatação. Consulte a documentação de DrawText para obter uma lista completa de opções.

lpDTParams [in]

Tipo: LPDRAWTEXTPARAMS

Um ponteiro para uma estrutura DRAWTEXTPARAMS que especifica opções de formatação adicionais. Este parâmetro pode ser NULL.

Valor retornado

Tipo: int

Se a função for bem-sucedida, o valor retornado será a altura do texto em unidades lógicas. Se DT_VCENTER ou DT_BOTTOM for especificado, o valor retornado será o deslocamento do membro superior de lprc para a parte inferior do texto desenhado Se a função falhar, o valor retornado será zero.

Se a função falhar, o valor retornado será zero.

Para obter informações de erro estendidas, chame GetLastError.

Comentários

DrawTextWrap não é exportado por nome ou declarado em um cabeçalho público. Para usá-lo, você deve usar GetProcAddress e solicitar o ordinal 415 de ComCtl32.dll para obter um ponteiro de função.

Para comentários adicionais, consulte DrawText.

Requisitos

Requisito Valor
Cliente mínimo com suporte
 Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
 Windows Server 2003 [somente aplicativos da área de trabalho]
DLL
Comctl32.dll (versão 6.0 ou posterior)