Função GetWindowTextLengthA (winuser.h)

Artigo
11/20/2024

Recupera o comprimento, em caracteres, do texto da barra de título da janela especificada (se a janela tiver uma barra de título). Se a janela especificada for um controle, a função recuperará o comprimento do texto dentro do controle. No entanto, GetWindowTextLength não pode recuperar o comprimento do texto de um controle de edição em outro aplicativo.

Sintaxe

int GetWindowTextLengthA(
  [in] HWND hWnd
);

Parâmetros

[in] hWnd

Tipo: HWND

Um identificador para a janela ou controle.

Valor de retorno

Tipo: int

Se a função for bem-sucedida, o valor retornado será o comprimento, em caracteres, do texto. Em determinadas condições, esse valor pode ser maior que o comprimento do texto (consulte Comentários).

Se a janela não tiver texto, o valor retornado será zero.

A falha de função é indicada por um valor retornado igual a zero e um GetLastError resultado diferente de zero.

Nota

Essa função não limpa as informações de erro mais recentes. Para determinar o êxito ou falha, desmarque as informações de erro mais recentes chamando SetLastError com 0 e, em seguida, chame GetLastError.

Observações

Se a janela de destino pertencer ao processo atual, GetWindowTextLength fará com que uma mensagem WM_GETTEXTLENGTH seja enviada para a janela ou controle especificado.

Em determinadas condições, a função GetWindowTextLength pode retornar um valor maior que o comprimento real do texto. Isso ocorre com determinadas misturas de ANSI e Unicode e se deve ao sistema que permite a possível existência de caracteres DBCS (conjunto de caracteres de byte duplo) dentro do texto. O valor retornado, no entanto, sempre será pelo menos tão grande quanto o comprimento real do texto; assim, você sempre pode usá-lo para orientar a alocação de buffer. Esse comportamento pode ocorrer quando um aplicativo usa funções ANSI e caixas de diálogo comuns, que usam Unicode. Também pode ocorrer quando um aplicativo usa a versão ANSI do GetWindowTextLength com uma janela cujo procedimento de janela é Unicode ou a versão Unicode do GetWindowTextLength com uma janela cujo procedimento de janela é ANSI. Para obter mais informações sobre as funções ANSI e ANSI, consulte Conventions for Function Prototypes.

Para obter o comprimento exato do texto, use as mensagens WM_GETTEXT, LB_GETTEXTou CB_GETLBTEXT ou a função GetWindowText.

Nota

O cabeçalho winuser.h define GetWindowTextLength como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winuser.h (inclua Windows.h)
biblioteca	User32.lib
de DLL	User32.dll
conjunto de API	ext-ms-win-ntuser-window-l1-1-1 (introduzido no Windows 8.1)