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

Статья
11/20/2024

Извлекает указанное 32-разрядное значение (DWORD) из структуры WNDCLASSEX , связанной с указанным окном.

Примечание Если вы извлекаете указатель или дескриптор, эта функция заменена функцией GetClassLongPtr. (Указатели и дескрипторы — это 32-разрядные 32-разрядные оси Windows и 64-разрядные устройства в 64-разрядной версии Windows.)

Синтаксис

DWORD GetClassLongA(
  [in] HWND hWnd,
  [in] int  nIndex
);

Параметры

[in] hWnd

Тип: HWND

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

[in] nIndex

Тип: int

Извлекаемое значение. Чтобы получить значение из дополнительной памяти класса, укажите положительное отсчитываемое от нуля смещение байтов, которое необходимо извлечь. Допустимые значения находятся в диапазоне от нуля до количества байтов памяти дополнительного класса, минус четыре; Например, если задано 12 или более байтов дополнительной памяти класса, значение 8 будет индексом в третье целое число. Чтобы получить любое другое значение из структуры WNDCLASSEX, укажите одно из следующих значений.

Ценность	Значение
GCW_ATOM -32	Извлекает значение ATOM, однозначно определяющее класс окна. Это тот же атом, что функция RegisterClassEx возвращает .
GCL_CBCLSEXTRA -20	Извлекает размер в байтах дополнительной памяти, связанной с классом.
GCL_CBWNDEXTRA -18	Извлекает размер в байтах из дополнительной памяти окна, связанной с каждым окном в классе. Сведения о том, как получить доступ к этой памяти, см. в GetWindowLong.
GCL_HBRBACKGROUND -10	Извлекает дескриптор фоновой кисти, связанной с классом.
GCL_HCURSOR -12	Извлекает дескриптор курсора, связанного с классом.
GCL_HICON -14	Извлекает дескриптор, связанный с классом.
GCL_HICONSM -34	Извлекает дескриптор на маленький значок, связанный с классом.
GCL_HMODULE -16	Извлекает дескриптор модуля, который зарегистрировал класс.
GCL_MENUNAME -8	Извлекает адрес строки имени меню. Строка определяет ресурс меню, связанный с классом.
GCL_STYLE -26	Извлекает биты стиля класса окна.
GCL_WNDPROC -24	Извлекает адрес процедуры окна или дескриптор, представляющий адрес процедуры окна. Для вызова процедуры окна необходимо использовать функцию CallWindowProc.

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

Тип: DWORD

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

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

Замечания

Зарезервируйте дополнительную память класса, указав ненулевое значение в элементе cbClsExtra члена структуры WNDCLASSEX, используемой с функцией RegisterClassEx.

Заметка

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

Требования

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