Функция GetDlgItemTextA (winuser.h)

Статья
08/27/2023

Извлекает заголовок или текст, связанный с элементом управления в диалоговом окне.

Синтаксис

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

Параметры

[in] hDlg

Тип: HWND

Дескриптор диалогового окна, содержащего элемент управления .

[in] nIDDlgItem

Тип: int

Идентификатор элемента управления, заголовок или текст которого требуется извлечь.

[out] lpString

Тип: LPTSTR

Буфер для получения заголовка или текста.

[in] cchMax

Тип: int

Максимальная длина (в символах) строки, копируемый в буфер, на который указывает lpString. Если длина строки, включая символ NULL, превышает ограничение, строка усекается.

Возвращаемое значение

Тип: UINT

Если функция выполняется успешно, возвращаемое значение указывает количество символов, скопированных в буфер, не включая завершающий символ NULL.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Заголовок winuser.h определяет GetDlgItemText в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winuser.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll
Набор API	ext-ms-win-ntuser-dialogbox-l1-1-0 (представлено в Windows 8)