Win32 API. Справочник по диалоговому окну - Функция GetDlgItemInt

ОГЛАВЛЕНИЕ

Функция GetDlgItemInt

(ПолучитьЦелочисленноеЗначениеЭлементаДиалога)

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

Синтаксис

UINT GetDlgItemInt
(
HWND hDlg, // дескриптор диалогового окна
int nIDDlgItem, // идентификатор элемента управления
BOOL *lpTranslated, // указывает на переменную, которая принимает
// индикатор успешного завершения/неудачи
BOOL bSigned // определяет со знаком ли значение или без знака
);

Параметры
hDlg
Дескриптор диалогового окна, которое содержит представляющий интерес орган управления.
nIDDlgItem
Идентификатор элемента блока диалога, который определяет орган управления, текст которого должен быть преобразован.
lpTranslated
Указывает на Булеву переменную, которая принимает значение функции успешного завершения / неудачи. Значение ИСТИНА (TRUE) указывает на успешное завершение, значение ЛОЖЬ(FALSE) указывает на неудачу.
Этот параметр необязательный: он может быть значением ПУСТО (NULL). В этом случае, функция не возвращает информации об успехе или неудаче.
bSigned
Определяет, должна ли функция сначала проверять текст на знак "минус" и возвращать значение целого числа со знаком, если она находит его. Значение ИСТИНА (TRUE) устанавливает, что это должно быть сделано, ЛОЖЬ (FALSE), что этого делать не надо.

Возвращаемые значения
Если функция завершается успешно, переменная, указанная в lpTranslated устанавливается в значение ИСТИНА (TRUE), а возвращаемое значение – в преобразованное значение текста органа управления.
Если функция не выполняет задачу, переменная, указанная в lpTranslated устанавливается в значение ЛОЖЬ(FALSE), а возвращаемое значение нулевое. Обратите внимание, что, так как нуль - возможное значение после преобразования, возвращаемое значение нуль сам по себе не указывает на неудачу.
Если lpTranslated значение ПУСТО (NULL), функция не возвращает никакой информации относительно успеха или неудачи.
Если параметр bSigned имеет значение ИСТИНА (TRUE), то определяет, что значение, которое будет возвращено обратно, является значением целого числа со знаком и приводит возвращаемое значение к типу int.

Замечания
Функция GetDlgItemInt извлекает текст данного органа управления, отправляя элементу управления сообщение WM_GETTEXT. Функция преобразует извлеченный текст, очищая его от любых дополнительных пробелов в начале текста, а затем преобразует в десятичные цифры. Функция останавливает преобразование тогда, когда она достигает конца текста или сталкивается с нечисловым символом.
Если параметр bSigned имеет значение ИСТИНА (TRUE), функция GetDlgItemInt проверяет знак "минус" (-) в начале текста и преобразует текст в значение целого числа со знаком. Иначе, функция создает значение целого числа без знака.
Функция GetDlgItemInt возвращает значение нуль, если преобразованное значение большее, чем INT_MAX (для знаковых чисел) или UINT_MAX (для чисел без знака).

Смотри также
GetDlgCtrlID, GetDlgItem, GetDlgItemText, SetDlgItemInt

Размещение и совместимость GetDlgItemInt

Windows NT				Да 
Win95 Да
Win32s Да
Импортируемая библиотека user32.lib
Заголовочный файл winuser.h
Unicode Нет
Замечания по платформе Не имеется