GetDlgItemTextA-Funktion (winuser.h)

Artikel
03/04/2024

Ruft den Titel oder Text ab, der mit einem Steuerelement in einem Dialogfeld verknüpft 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, um den Titel oder Text zu empfangen.

[in] cchMax

Typ: int

Die maximale Länge der Zeichenfolge in Zeichen, die in den Puffer kopiert werden soll, auf den lpString verweist. Wenn die Länge der Zeichenfolge, einschließlich des NULL-Zeichens, 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, ohne das beendende NULL-Zeichen.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

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

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

Beispiele

Ein Beispiel finden Sie unter Erstellen eines modalen Dialogfelds.

Hinweis

Der winuser.h-Header definiert GetDlgItemText als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code 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
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (einschließlich Windows.h)
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-dialogbox-l1-1-0 (eingeführt in Windows 8)