Função ImageList_SetOverlayImage (commctrl.h)

Adiciona uma imagem especificada à lista de imagens a serem usadas como máscaras de sobreposição. Uma lista de imagens pode ter até quatro máscaras de sobreposição na versão 4.70 e anteriores e até 15 na versão 4.71. A função atribui um índice de máscara de sobreposição à imagem especificada.

Sintaxe

BOOL ImageList_SetOverlayImage(
  [in] HIMAGELIST himl,
  [in] int        iImage,
  [in] int        iOverlay
);

Parâmetros

[in] himl

Tipo: HIMAGELIST

Um identificador para a lista de imagens.

[in] iImage

Tipo: int

O índice baseado em zero de uma imagem na lista de imagens himl . Esse índice identifica a imagem a ser usada como uma máscara de sobreposição.

[in] iOverlay

Tipo: int

O índice baseado em um da máscara de sobreposição.

Retornar valor

Tipo: BOOL

Retorna diferente de zero se tiver êxito; caso contrário, zero.

Comentários

Uma máscara de sobreposição é uma imagem desenhada de forma transparente sobre outra imagem. Para desenhar uma máscara de sobreposição sobre uma imagem, chame a função ImageList_Draw ou ImageList_DrawEx . O parâmetro fStyle dessas funções pode usar a macro INDEXTOOVERLAYMASK para especificar um índice de máscara de sobreposição.

Uma chamada para esse método falha e retorna E_INVALIDARG, a menos que a lista de imagens seja criada usando uma máscara.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [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	commctrl.h
Biblioteca	Comctl32.lib
DLL	Comctl32.dll
Conjunto de APIs	ext-ms-win-shell-comctl32-init-l1-1-1 (introduzido no Windows 10, versão 10.0.14393)