Método IShellIconOverlay::GetOverlayIconIndex (shlobj_core.h)

  • Artigo

Obtém o índice da sobreposição de ícone na lista de imagens do sistema.

Sintaxe

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

Parâmetros

[in] pidl

Tipo: PCUITEMID_CHILD

Ponteiro para uma estrutura ITEMIDLIST que identifica o objeto cujo ícone está sendo exibido.

[in, out] pIconIndex

Tipo: int*

Ponteiro para o índice da imagem da sobreposição do ícone na lista de imagens do sistema. Esse índice é equivalente ao valor iImage especificado quando você adiciona uma imagem de sobreposição a uma lista de imagens privadas com a função ImageList::SetOverlayImage .

Retornar valor

Tipo: HRESULT

Esse método pode retornar um desses valores.

Código de retorno Descrição
S_OK
 O índice de uma sobreposição foi encontrado.
S_FALSE
 Não existe sobreposição para esse arquivo.
E_FAIL
 O PIDL é inválido.

Comentários

Para recuperar o índice de imagem da sobreposição na lista de imagens do sistema, você deve primeiro chamar SHGetIconOverlayIndex para recuperar o índice de sobreposição. Em seguida, use a macro INDEXTOOVERLAYMASK para converter o índice de sobreposição no índice de imagem equivalente.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional, 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 shlobj_core.h
DLL Shell32.dll (versão 5.0 ou posterior)

Confira também

IShellIconOverlay