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

Статья
03/04/2024

Получает ключ цвета прозрачности многослойного окна.

Синтаксис

BOOL GetLayeredWindowAttributes(
  [in]            HWND     hwnd,
  [out, optional] COLORREF *pcrKey,
  [out, optional] BYTE     *pbAlpha,
  [out, optional] DWORD    *pdwFlags
);

Параметры

[in] hwnd

Тип: HWND

Дескриптор многоуровневого окна. Многоуровневое окно создается путем указания WS_EX_LAYERED при создании окна с помощью функции CreateWindowEx или установки WS_EX_LAYERED с помощью SetWindowLong после создания окна.

[out, optional] pcrKey

Тип: COLORREF*

Указатель на значение COLORREF , которое получает ключ цвета прозрачности, используемый при создании многоуровневого окна. Все пиксели, окрашенные окном в этот цвет, будут прозрачными. Это значение может иметь значение NULL , если аргумент не требуется.

[out, optional] pbAlpha

Тип: BYTE*

Значение Alpha, используемое для описания непрозрачности многоуровневого окна. Аналогично члену SourceConstantAlpha структуры BLENDFUNCTION . Если переменная, на которую ссылается pbAlpha , имеет значение 0, окно становится полностью прозрачным. Если переменная, на которую ссылается pbAlpha , имеет значение 255, окно становится непрозрачным. Это значение может иметь значение NULL , если аргумент не требуется.

[out, optional] pdwFlags

Тип: DWORD*

Флаг наложения. Этот параметр может иметь значение NULL , если значение не требуется. Флаг слои может быть одним или несколькими из следующих значений.

Значение	Значение
LWA_ALPHA 0x00000002	Используйте pbAlpha для определения непрозрачности многоуровневого окна.
LWA_COLORKEY 0x00000001	Используйте pcrKey в качестве цвета прозрачности.

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

Тип: BOOL

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

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

Метод GetLayeredWindowAttributes можно вызывать только в том случае, если приложение ранее вызывало SetLayeredWindowAttributes в окне. Функция завершится ошибкой, если многоуровневые окна были настроены с помощью UpdateLayeredWindow.

Дополнительные сведения см. в разделе Использование многоуровневой оси Windows.

Требования

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