DialogBoxParamA, fonction (winuser.h)

Article
03/04/2024

Crée une boîte de dialogue modale à partir d’une ressource de modèle de boîte de dialogue. Avant d’afficher la boîte de dialogue, la fonction transmet une valeur définie par l’application à la procédure de boîte de dialogue en tant que paramètre lParam du message WM_INITDIALOG . Une application peut utiliser cette valeur pour initialiser des contrôles de boîte de dialogue.

Syntaxe

INT_PTR DialogBoxParamA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpTemplateName,
  [in, optional] HWND      hWndParent,
  [in, optional] DLGPROC   lpDialogFunc,
  [in]           LPARAM    dwInitParam
);

Paramètres

[in, optional] hInstance

Type : HINSTANCE

Handle du module qui contient le modèle de boîte de dialogue. Si ce paramètre a la valeur NULL, l’exécutable actuel est utilisé.

[in] lpTemplateName

Type : LPCTSTR

Modèle de boîte de dialogue. Ce paramètre est soit le pointeur vers une chaîne de caractères terminée par null qui spécifie le nom du modèle de boîte de dialogue, soit une valeur entière qui spécifie l’identificateur de ressource du modèle de boîte de dialogue. Si le paramètre spécifie un identificateur de ressource, son mot d’ordre supérieur doit être égal à zéro et son mot d’ordre inférieur doit contenir l’identificateur. Vous pouvez utiliser la macro MAKEINTRESOURCE pour créer cette valeur.

[in, optional] hWndParent

Type : HWND

Handle de la fenêtre qui possède la boîte de dialogue.

[in, optional] lpDialogFunc

Type : DLGPROC

Pointeur vers la procédure de boîte de dialogue. Pour plus d’informations sur la procédure de boîte de dialogue, consultez DialogProc.

[in] dwInitParam

Type : LPARAM

Valeur à passer à la boîte de dialogue dans le paramètre lParam du message WM_INITDIALOG .

Valeur retournée

Type : INT_PTR

Si la fonction réussit, la valeur de retour est la valeur du paramètre nResult spécifié dans l’appel à la fonction EndDialog utilisée pour arrêter la boîte de dialogue.

Si la fonction échoue parce que le paramètre hWndParent n’est pas valide, la valeur de retour est zéro. La fonction retourne zéro dans ce cas pour la compatibilité avec les versions précédentes de Windows. Si la fonction échoue pour une autre raison, la valeur de retour est –1. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

La fonction DialogBoxParam utilise la fonction CreateWindowEx pour créer la boîte de dialogue. DialogBoxParam envoie ensuite un message WM_INITDIALOG (et un message WM_SETFONT si le modèle spécifie le style DS_SETFONT ou DS_SHELLFONT) à la procédure de boîte de dialogue. La fonction affiche la boîte de dialogue (que le modèle spécifie ou non le style WS_VISIBLE ), désactive la fenêtre propriétaire et démarre sa propre boucle de message pour récupérer et distribuer les messages pour la boîte de dialogue.

Lorsque la procédure de boîte de dialogue appelle la fonction EndDialog , DialogBoxParam détruit la boîte de dialogue, met fin à la boucle des messages, active la fenêtre propriétaire (si elle est activée précédemment) et retourne le paramètre nResult spécifié par la procédure de boîte de dialogue lorsqu’elle a appelé EndDialog.

Notes

L’en-tête winuser.h définit DialogBoxParam en tant qu’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. La combinaison 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.

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-1 (introduit dans Windows 8.1)