Função GetLayeredWindowAttributes (winuser.h)

Artigo
03/04/2024

Recupera a chave de cor de opacidade e transparência de uma janela em camadas.

Sintaxe

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

Parâmetros

[in] hwnd

Digite: HWND

Um identificador para a janela em camadas. Uma janela em camadas é criada especificando WS_EX_LAYERED ao criar a janela com a função CreateWindowEx ou definindo WS_EX_LAYERED usando SetWindowLong após a criação da janela.

[out, optional] pcrKey

Tipo: COLORREF*

Um ponteiro para um valor COLORREF que recebe a chave de cor de transparência a ser usada ao redigir a janela em camadas. Todos os pixels pintados pela janela nessa cor serão transparentes. Isso poderá ser NULL se o argumento não for necessário.

[out, optional] pbAlpha

Tipo: BYTE*

O valor Alfa usado para descrever a opacidade da janela em camadas. Semelhante ao membro SourceConstantAlpha da estrutura BLENDFUNCTION . Quando a variável referenciada por pbAlpha é 0, a janela é completamente transparente. Quando a variável referenciada por pbAlpha é 255, a janela é opaca. Isso poderá ser NULL se o argumento não for necessário.

[out, optional] pdwFlags

Tipo: DWORD*

Um sinalizador em camadas. Esse parâmetro poderá ser NULL se o valor não for necessário. O sinalizador de camadas pode ser um ou mais dos valores a seguir.

Valor	Significado
LWA_ALPHA 0x00000002	Use pbAlpha para determinar a opacidade da janela em camadas.
LWA_COLORKEY 0x00000001	Use pcrKey como a cor de transparência.

Retornar valor

Tipo: BOOL

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

GetLayeredWindowAttributes só poderá ser chamado se o aplicativo tiver chamado SetLayeredWindowAttributes anteriormente na janela. A função falhará se a janela em camadas tiver sido configurada com UpdateLayeredWindow.

Para obter mais informações, consulte Usando o Windows em camadas.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-window-l1-1-1 (introduzido em Windows 8.1)