Função SHGetStockIconInfo (shellapi.h)

Recupera informações sobre ícones do Shell definidos pelo sistema.

Sintaxe

SHSTDAPI SHGetStockIconInfo(
            SHSTOCKICONID   siid,
            UINT            uFlags,
  [in, out] SHSTOCKICONINFO *psii
);

Parâmetros

siid

Tipo: SHSTOCKICONID

Um dos valores da enumeração SHSTOCKICONID que especifica qual ícone deve ser recuperado.

uFlags

Tipo: UINT

Uma combinação de zero ou mais dos sinalizadores a seguir que especificam quais informações são solicitadas.

SHGSI_ICONLOCATION

Os membros szPath e iIcon da estrutura SHSTOCKICONINFO recebem o caminho e o índice de ícone do ícone solicitado, em um formato adequado para passar para a função ExtractIcon . O valor numérico desse sinalizador é zero, portanto, você sempre obtém o local do ícone, independentemente de outros sinalizadores.

SHGSI_ICON

O membro hIcon da estrutura SHSTOCKICONINFO recebe um identificador para o ícone especificado.

SHGSI_SYSICONINDEX

O membro iSysImageImage da estrutura SHSTOCKICONINFO recebe o índice do ícone especificado na lista de imagens do sistema.

SHGSI_LINKOVERLAY

Modifica o valor SHGSI_ICON fazendo com que a função adicione a sobreposição de link ao ícone do arquivo.

SHGSI_SELECTED

Modifica o valor SHGSI_ICON fazendo com que a função misture o ícone com a cor de realce do sistema.

SHGSI_LARGEICON

Modifica o valor SHGSI_ICON fazendo com que a função recupere a versão grande do ícone, conforme especificado pelas métricas do sistema SM_CXICON e SM_CYICON.

SHGSI_SMALLICON

Modifica o valor SHGSI_ICON fazendo com que a função recupere a pequena versão do ícone, conforme especificado pelas métricas do sistema SM_CXSMICON e SM_CYSMICON.

SHGSI_SHELLICONSIZE

Modifica os valores SHGSI_LARGEICON ou SHGSI_SMALLICON fazendo com que a função recupere os ícones do tamanho do Shell em vez dos tamanhos especificados pelas métricas do sistema.

[in, out] psii

Tipo: SHSTOCKICONINFO*

Um ponteiro para uma estrutura SHSTOCKICONINFO . Quando essa função é chamada, o membro cbSize dessa estrutura precisa ser definido como o tamanho da estrutura SHSTOCKICONINFO . Quando essa função retorna, contém um ponteiro para uma estrutura SHSTOCKICONINFO que contém as informações solicitadas.

Retornar valor

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Se essa função retornar um identificador de ícone no membro hIcon da estrutura SHSTOCKICONINFO apontada por psii, você será responsável por liberar o ícone com DestroyIcon quando não precisar mais dela.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shellapi.h
DLL	Shell32.dll
Conjunto de APIs	ext-ms-win-shell32-l1-2-1 (introduzido no Windows 10, versão 10.0.10240)