Método IImageList::SetOverlayImage (commoncontrols.h)

Adiciona uma imagem especificada à lista de imagens usadas como máscaras de sobreposição. Uma lista de imagens pode ter até quatro máscaras de sobreposição no Common Controls versão 4.70 e anterior e até 15 na versão 4.71 ou posterior. O método atribui um índice de máscara de sobreposição à imagem especificada.

Sintaxe

HRESULT SetOverlayImage(
  [in] int iImage,
  [in] int iOverlay
);

Parâmetros

[in] iImage

Tipo: int

Um valor do tipo int que contém o índice baseado em zero de uma imagem na lista de imagens. Esse índice identifica a imagem a ser usada como uma máscara de sobreposição.

[in] iOverlay

Tipo: int

Um valor do tipo int que contém o índice baseado em um da máscara de sobreposição.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

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 IImageList::D raw. 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.

Para usar IImageList::SetOverlayImage, especifique Comctl32.dll versão 6 no manifesto. Para obter mais informações sobre manifestos, consulte Habilitando estilos visuais.

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	commoncontrols.h
DLL	Comctl32.dll (versão 6.0 ou posterior)