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

Статья
08/27/2023

Преобразует текст указанного элемента управления в диалоговом окне в целочисленное значение.

Синтаксис

UINT GetDlgItemInt(
  [in]            HWND hDlg,
  [in]            int  nIDDlgItem,
  [out, optional] BOOL *lpTranslated,
  [in]            BOOL bSigned
);

Параметры

[in] hDlg

Тип: HWND

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

[in] nIDDlgItem

Тип: int

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

[out, optional] lpTranslated

Тип: BOOL*

Указывает на успех или сбой (ЗНАЧЕНИЕ TRUE указывает на успешное выполнение, FALSE — на сбой).

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

[in] bSigned

Тип: BOOL

Указывает, должна ли функция проверять текст на наличие знака "минус" в начале и возвращать целочисленное значение со знаком при его обнаружении (значение TRUE указывает, что это должно быть сделано, значение FALSE — нет).

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

Тип: UINT

Если функция выполняется успешно, переменная, на которую указывает lpTranslated , имеет значение TRUE, а возвращаемое значение — это переведенное значение текста элемента управления.

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

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

Обратите внимание, что если параметр bSigned имеет значение TRUE и в начале текста есть знак минуса (–), GetDlgItemInt преобразует текст в целое число со знаком. В противном случае функция создает целочисленное значение без знака. Чтобы получить правильное значение в этом случае, приведите возвращаемое значение к типу int .

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

Функция GetDlgItemInt извлекает текст указанного элемента управления, отправляя элементу управления WM_GETTEXT сообщение. Функция преобразует полученный текст путем удаления лишних пробелов в начале текста и последующего преобразования десятичных цифр. Функция прекращает перевод, когда она достигает конца текста или встречает нечисловый символ.

Функция GetDlgItemInt возвращает ноль, если переведенное значение больше INT_MAX (для цифр со знаком) или UINT_MAX (для неподписанных чисел).

Примеры

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

Требования

Требование	Значение
Минимальная версия клиента	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-2 (появилось в Windows 10 версии 10.0.10240)