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

Статья
11/20/2024

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

Синтаксис

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.

Замечания

Если строка длинна или длиннее буфера, буфер будет содержать усеченную строку с завершающим символом NULL.

Функция GetDlgItemText отправляет WM_GETTEXT сообщение в элемент управления.

Примеры

Пример см. в разделе Создание модального диалогового окна.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-dialogbox-l1-1-0 (представлено в Windows 8)