Função SHGetIconOverlayIndexA (shlobj_core.h)

Artigo
11/20/2024

Retorna o índice do ícone de sobreposição na lista de imagens do sistema.

Sintaxe

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

Parâmetros

[in, optional] pszIconPath

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo de comprimento máximo MAX_PATH que contém o caminho totalmente qualificado do arquivo que contém o ícone.

iIconIndex

Tipo: int

O índice do ícone no arquivo apontado por pszIconPath. Para solicitar um ícone de sobreposição padrão, defina pszIconPath para NULL e iIconIndex como um dos seguintes:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

O ícone de sobreposição que indica uma pasta compartilhada.

IDO_SHGIOI_LINK (0x0FFFFFFE)

O ícone de sobreposição que indica uma pasta ou arquivo vinculado.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

O ícone de sobreposição que indica um arquivo lento.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 e posteriores. O ícone de sobreposição que indica que o item é o padrão em um conjunto. Um exemplo é a impressora padrão.

Valor de retorno

Tipo: int

Retorna o índice do ícone de sobreposição na lista de imagens do sistema se tiver êxito ou -1 de outra forma.

Observações

As sobreposições de ícones fazem parte da lista de imagens do sistema. Eles têm dois identificadores. O primeiro é um índice de sobreposição baseado em um que identifica a sobreposição em relação a outras sobreposições na lista de imagens. O outro é um índice de imagem que identifica a imagem real. Esses dois índices são equivalentes aos valores que você atribui aos parâmetros iOverlay e iImage, respectivamente, quando você adiciona uma sobreposição de ícone a uma lista de imagens privadas com ImageList_SetOverlayImage. SHGetIconOverlayIndex retorna o índice de sobreposição. Para converter um índice de sobreposição em seu índice de imagem equivalente, chame INDEXTOOVERLAYMASK.

Observação Depois que a imagem tiver sido carregada na lista de imagens do sistema durante a inicialização, ela não poderá ser alterada. O nome do arquivo e o índice especificados por pszIconPath e iIconIndex são usados apenas para identificar a sobreposição de ícone. SHGetIconOverlayIndex não pode ser usado para modificar a lista de imagens do sistema.

Nota

O cabeçalho shlobj_core.h define SHGetIconOverlayIndex como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shlobj_core.h (inclua Shlobj.h, Shlobj_core.h)
biblioteca	Shell32.lib
de DLL	Shell32.dll (versão 5.0 ou posterior)

Consulte também

IShellIconOverlay

IShellIconOverlayIdentifier

Compartilhar via