DialogBoxParamA-Funktion (winuser.h)

Artikel
11/20/2024

Erstellt ein modales Dialogfeld aus einer Ressourcenressource für Dialogfeldvorlagen. Vor dem Anzeigen des Dialogfelds übergibt die Funktion einen anwendungsdefinierten Wert als lParam- Parameter der WM_INITDIALOG Nachricht an die Dialogfeldprozedur. Eine Anwendung kann diesen Wert verwenden, um Dialogfeld-Steuerelemente zu initialisieren.

Syntax

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

Parameter

[in, optional] hInstance

Typ: HINSTANCE-

Ein Handle für das Modul, das die Dialogfeldvorlage enthält. Wenn dieser Parameter NULL ist, wird die aktuelle ausführbare Datei verwendet.

[in] lpTemplateName

Typ: LPCTSTR-

Die Dialogfeldvorlage. Dieser Parameter ist entweder der Zeiger auf eine mit Null beendete Zeichenfolge, die den Namen der Dialogfeldvorlage oder einen ganzzahligen Wert angibt, der den Ressourcenbezeichner der Dialogfeldvorlage angibt. Wenn der Parameter einen Ressourcenbezeichner angibt, muss das Wort mit hoher Reihenfolge null sein, und das Wort mit niedriger Reihenfolge muss den Bezeichner enthalten. Sie können das MAKEINTRESOURCE Makro verwenden, um diesen Wert zu erstellen.

[in, optional] hWndParent

Typ: HWND-

Ein Handle für das Fenster, das das Dialogfeld besitzt.

[in, optional] lpDialogFunc

Typ: DLGPROC-

Ein Zeiger auf die Dialogfeldprozedur. Weitere Informationen zur Dialogfeldprozedur finden Sie unter DialogProc-.

[in] dwInitParam

Typ: LPARAM-

Der Wert, der an das Dialogfeld im lParam- Parameter der WM_INITDIALOG Nachricht übergeben werden soll.

Rückgabewert

Typ: INT_PTR

Wenn die Funktion erfolgreich ist, ist der Rückgabewert der Wert des nResult- Parameters, der im Aufruf der EndDialog-Funktion angegeben ist, die zum Beenden des Dialogfelds verwendet wird.

Wenn die Funktion fehlschlägt, da der hWndParent Parameter ungültig ist, ist der Rückgabewert null. Die Funktion gibt in diesem Fall null aus Gründen der Kompatibilität mit früheren Versionen von Windows zurück. Wenn die Funktion aus einem anderen Grund fehlschlägt, lautet der Rückgabewert -1. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Die DialogBoxParam--Funktion verwendet die CreateWindowEx--Funktion, um das Dialogfeld zu erstellen. DialogBoxParam sendet dann eine WM_INITDIALOG Nachricht (und eine WM_SETFONT Nachricht, wenn die Vorlage die DS_SETFONT oder DS_SHELLFONT Formatvorlage angibt) an die Dialogfeldprozedur. Die Funktion zeigt das Dialogfeld an (unabhängig davon, ob die Vorlage die WS_VISIBLE Formatvorlage angibt), deaktiviert das Besitzerfenster und startet eine eigene Nachrichtenschleife zum Abrufen und Verteilen von Nachrichten für das Dialogfeld.

Wenn die Dialogfeldprozedur die funktion EndDialog aufruft, zerstört DialogBoxParam das Dialogfeld, beendet die Meldungsschleife, aktiviert das Besitzerfenster (sofern zuvor aktiviert), und gibt den nResult Parameter zurück, der durch die Dialogfeldprozedur beim Aufruf EndDialogangegeben wird.

Anmerkung

Der winuser.h-Header definiert DialogBoxParam als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winuser.h (enthalten Windows.h)
Library	User32.lib
DLL-	User32.dll
API-Satz	ext-ms-win-ntuser-dialogbox-l1-1-1 (eingeführt in Windows 8.1)