Função GetDlgItemTextA (winuser.h)

Artigo
03/13/2024

Recupera o título ou texto associado a um controle em uma caixa de diálogo.

Sintaxe

UINT GetDlgItemTextA(
  [in]  HWND  hDlg,
  [in]  int   nIDDlgItem,
  [out] LPSTR lpString,
  [in]  int   cchMax
);

Parâmetros

[in] hDlg

Digite: HWND

Um identificador para a caixa de diálogo que contém o controle .

[in] nIDDlgItem

Tipo: int

O identificador do controle cujo título ou texto deve ser recuperado.

[out] lpString

Tipo: LPTSTR

O buffer para receber o título ou o texto.

[in] cchMax

Tipo: int

O comprimento máximo, em caracteres, da cadeia de caracteres a ser copiada para o buffer apontado por lpString. Se o comprimento da cadeia de caracteres, incluindo o caractere nulo, exceder o limite, a cadeia de caracteres será truncada.

Retornar valor

Tipo: UINT

Se a função tiver êxito, o valor retornado especificará o número de caracteres copiados para o buffer, sem incluir o caractere nulo de encerramento.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Se a cadeia de caracteres for tão longa ou maior que o buffer, o buffer conterá a cadeia de caracteres truncada com um caractere nulo de terminação.

A função GetDlgItemText envia uma mensagem WM_GETTEXT para o controle.

Exemplos

Para obter um exemplo, consulte Criando uma caixa de diálogo modal.

Observação

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-dialogbox-l1-1-0 (introduzido no Windows 8)