GetDlgItemInt, fonction (winuser.h)

Article
03/13/2024

Convertit le texte d’un contrôle spécifié dans une boîte de dialogue en valeur entière.

Syntaxe

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

Paramètres

[in] hDlg

Type : HWND

Handle de la boîte de dialogue qui contient le contrôle d’intérêt.

[in] nIDDlgItem

Type : int

Identificateur du contrôle dont le texte doit être traduit.

[out, optional] lpTranslated

Type : BOOL*

Indique la réussite ou l’échec (TRUE indique la réussite, FALSE indique l’échec).

Si ce paramètre a la valeur NULL, la fonction ne retourne aucune information sur la réussite ou l’échec.

[in] bSigned

Type : BOOL

Indique si la fonction doit examiner le texte pour rechercher un signe moins au début et retourner une valeur entière signée si elle en trouve une (TRUE spécifie que cela doit être fait, FALSE qu’elle ne doit pas).

Valeur retournée

Type : UINT

Si la fonction réussit, la variable pointée vers lpTranslated est définie sur TRUE et la valeur de retour est la valeur traduite du texte de contrôle.

Si la fonction échoue, la variable pointée vers lpTranslated est définie sur FALSE et la valeur de retour est zéro. Notez que, étant donné que zéro est une valeur traduite possible, une valeur de retour de zéro n’indique pas à elle seule l’échec.

Si lpTranslated a la valeur NULL, la fonction ne retourne aucune information sur la réussite ou l’échec.

Notez que, si le paramètre bSigned a la valeur TRUE et qu’il existe un signe moins (–) au début du texte, GetDlgItemInt traduit le texte en une valeur entière signée. Sinon, la fonction crée une valeur entière non signée. Pour obtenir la valeur appropriée dans ce cas, castez la valeur de retour en type int .

Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

La fonction GetDlgItemInt récupère le texte du contrôle spécifié en envoyant au contrôle un message WM_GETTEXT . La fonction traduit le texte récupéré en supprimant les espaces supplémentaires au début du texte, puis en convertissant les chiffres décimaux. La fonction cesse de traduire lorsqu’elle atteint la fin du texte ou rencontre un caractère non numérique.

La fonction GetDlgItemInt retourne zéro si la valeur traduite est supérieure à INT_MAX (pour les nombres signés) ou UINT_MAX (pour les nombres non signés).

Exemples

Pour obtenir un exemple, consultez Création d’une boîte de dialogue sans mode.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-dialogbox-l1-1-2 (introduit dans Windows 10, version 10.0.10240)