GetDlgItemTextA, fonction (winuser.h)

Article
11/20/2024

Récupère le titre ou le texte associé à un contrôle dans une boîte de dialogue.

Syntaxe

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

Paramètres

[in] hDlg

Type : HWND

Handle de la boîte de dialogue qui contient le contrôle.

[in] nIDDlgItem

Type : int

Identificateur du contrôle dont le titre ou le texte doit être récupéré.

[out] lpString

Type : LPTSTR

Mémoire tampon pour recevoir le titre ou le texte.

[in] cchMax

Type : int

Longueur maximale, en caractères, de la chaîne à copier dans la mémoire tampon pointée par lpString. Si la longueur de la chaîne, y compris le caractère Null, dépasse la limite, la chaîne est tronquée.

Valeur de retour

Type : uiNT

Si la fonction réussit, la valeur de retour spécifie le nombre de caractères copiés dans la mémoire tampon, sans inclure le caractère null de fin.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

Si la chaîne est aussi longue ou plus longue que la mémoire tampon, la mémoire tampon contient la chaîne tronquée avec un caractère null de fin.

La fonction GetDlgItemText envoie un message WM_GETTEXT au contrôle.

Exemples

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

Note

L’en-tête winuser.h définit GetDlgItemText comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winuser.h (include Windows.h)
bibliothèque	User32.lib
DLL	User32.dll
ensemble d’API	ext-ms-win-ntuser-dialogbox-l1-1-0 (introduit dans Windows 8)