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

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

Sintaxe

HRESULT GetOverlayIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIndex
);

Parâmetros

[in] pidl

Tipo: PCUITEMID_CHILD

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

[in, out] pIndex

Tipo: int*

Ponteiro para um valor que declara o índice de sobreposição (baseado em um) na lista de imagens do sistema. Esse índice é equivalente ao valor iOverlay 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 este arquivo.
E_FAIL	O PIDL é inválido.
E_INVALIDARG	O argumento é inválido, por exemplo, se pIndex for NULL.
E_PENDING	O aplicativo de chamada passou OI_ASYNC para indicar que a operação de cálculo do índice de sobreposição levará algum tempo.

Comentários

Para recuperar o índice de sobreposição na lista de imagens do sistema, chame SHGetIconOverlayIndex.

Se você definir pIndex para apontar para OI_ASYNC ao chamar esse método, o manipulador de sobreposição de ícones do Shell poderá retornar E_PENDING em vez de armazenar o índice de sobreposição em pIndex. Esse valor retornado indica que a computação da sobreposição é uma operação lenta e deve ser tratada em segundo plano. Quando uma implementação IShellIconOverlay retorna E_PENDING, ela é chamada novamente em um thread de trabalho em segundo plano sem o sinalizador OI_ASYNC. Se você não usar OI_ASYNC ao chamar GetOverlayIndex, o manipulador de sobreposição deverá calcular o índice de sobreposição e armazenar o valor em pIndex antes de retornar.

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