GetDlgItemTextA-Funktion (winuser.h)

Artikel
11/20/2024

Ruft den Titel oder Text ab, der einem Steuerelement in einem Dialogfeld zugeordnet ist.

Syntax

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

Parameter

[in] hDlg

Typ: HWND-

Ein Handle für das Dialogfeld, das das Steuerelement enthält.

[in] nIDDlgItem

Typ: int

Der Bezeichner des Steuerelements, dessen Titel oder Text abgerufen werden soll.

[out] lpString

Typ: LPTSTR-

Der Puffer, der den Titel oder den Text empfängt.

[in] cchMax

Typ: int

Die maximale Länge der Zeichenfolge, die in Zeichen in den Puffer kopiert werden soll, auf lpString-verweist. Wenn die Länge der Zeichenfolge, einschließlich des Nullzeichens, den Grenzwert überschreitet, wird die Zeichenfolge abgeschnitten.

Rückgabewert

Typ: UINT-

Wenn die Funktion erfolgreich ist, gibt der Rückgabewert die Anzahl der zeichen an, die in den Puffer kopiert wurden, nicht einschließlich des endenden Nullzeichens.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Wenn die Zeichenfolge so lang oder länger als der Puffer ist, enthält der Puffer die abgeschnittene Zeichenfolge mit einem endenden NULL-Zeichen.

Die GetDlgItemText--Funktion sendet eine WM_GETTEXT Nachricht an das Steuerelement.

Beispiele

Ein Beispiel finden Sie unter Erstellen eines modalen Dialogfelds.

Anmerkung

Der winuser.h-Header definiert GetDlgItemText 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-0 (eingeführt in Windows 8)