Función GetLayeredWindowAttributes (winuser.h)

Artículo
03/04/2024

Recupera la clave de color de transparencia y opacidad de una ventana superpuesta.

Sintaxis

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

Parámetros

[in] hwnd

Tipo: HWND

Identificador de la ventana superpuesta. Se crea una ventana superpuesta especificando WS_EX_LAYERED al crear la ventana con la función CreateWindowEx o estableciendo WS_EX_LAYERED mediante SetWindowLong una vez creada la ventana.

[out, optional] pcrKey

Tipo: COLORREF*

Puntero a un valor COLORREF que recibe la clave de color de transparencia que se usará al componer la ventana superpuesta. Todos los píxeles pintados por la ventana de este color serán transparentes. Esto puede ser NULL si el argumento no es necesario.

[out, optional] pbAlpha

Tipo: BYTE*

Valor alfa utilizado para describir la opacidad de la ventana superpuesta. Similar al miembro SourceConstantAlpha de la estructura BLENDFUNCTION . Cuando la variable a la que hace referencia pbAlpha es 0, la ventana es completamente transparente. Cuando la variable a la que hace referencia pbAlpha es 255, la ventana es opaca. Esto puede ser NULL si el argumento no es necesario.

[out, optional] pdwFlags

Tipo: DWORD*

Una marca de capas. Este parámetro puede ser NULL si el valor no es necesario. La marca de capas puede ser uno o varios de los valores siguientes.

Valor	Significado
LWA_ALPHA 0x00000002	Use pbAlpha para determinar la opacidad de la ventana superpuesta.
LWA_COLORKEY 0x00000001	Use pcrKey como color de transparencia.

Valor devuelto

Tipo: BOOL

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Solo se puede llamar a GetLayeredWindowAttributes si la aplicación ha llamado previamente a SetLayeredWindowAttributes en la ventana. Se producirá un error en la función si la ventana superpuesta se configuró con UpdateLayeredWindow.

Para obtener más información, consulte Uso de Windows en capas.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-window-l1-1-1 (introducido en Windows 8.1)