Função GetDlgItemInt (winuser.h)

Artigo
08/27/2023

Converte o texto de um controle especificado em uma caixa de diálogo em um valor inteiro.

Sintaxe

UINT GetDlgItemInt(
  [in]            HWND hDlg,
  [in]            int  nIDDlgItem,
  [out, optional] BOOL *lpTranslated,
  [in]            BOOL bSigned
);

Parâmetros

[in] hDlg

Digite: HWND

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

[in] nIDDlgItem

Tipo: int

O identificador do controle cujo texto deve ser traduzido.

[out, optional] lpTranslated

Tipo: BOOL*

Indica êxito ou falha (TRUE indica êxito, FALSE indica falha).

Se esse parâmetro for NULL, a função não retornará nenhuma informação sobre êxito ou falha.

[in] bSigned

Tipo: BOOL

Indica se a função deve examinar o texto para um sinal de subtração no início e retornar um valor inteiro com sinal se encontrar um (TRUE especifica que isso deve ser feito, FALSE que não deve).

Retornar valor

Tipo: UINT

Se a função for bem-sucedida, a variável apontada por lpTranslated será definida como TRUE e o valor retornado será o valor traduzido do texto do controle.

Se a função falhar, a variável apontada por lpTranslated será definida como FALSE e o valor retornado será zero. Observe que, como zero é um valor traduzido possível, um valor retornado igual a zero não indica, por si só, falha.

Se lpTranslated for NULL, a função não retornará nenhuma informação sobre êxito ou falha.

Observe que, se o parâmetro bSigned for TRUE e houver um sinal de subtração (–) no início do texto, GetDlgItemInt converterá o texto em um valor inteiro com sinal. Caso contrário, a função criará um valor inteiro sem sinal. Para obter o valor adequado nesse caso, converta o valor retornado em um tipo int .

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

Comentários

A função GetDlgItemInt recupera o texto do controle especificado enviando ao controle uma mensagem WM_GETTEXT . A função converte o texto recuperado, tirando os espaços adicionais no início do texto e convertendo os dígitos decimais. A função interrompe a conversão, quando chega ao final do texto ou encontra um caractere não numérico.

A função GetDlgItemInt retornará zero se o valor traduzido for maior que INT_MAX (para números assinados) ou UINT_MAX (para números não assinados).

Exemplos

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

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-2 (introduzido no Windows 10, versão 10.0.10240)