Método IExtractIconA::Extract (shlobj_core.h)

Extrai uma imagem de ícone do local especificado.

Sintaxe

HRESULT Extract(
  [in]            PCSTR pszFile,
                  UINT  nIconIndex,
  [out, optional] HICON *phiconLarge,
  [out, optional] HICON *phiconSmall,
                  UINT  nIconSize
);

Parâmetros

[in] pszFile

Tipo: PCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o local do ícone.

nIconIndex

Tipo: UINT

O índice do ícone no arquivo apontado por pszFile.

[out, optional] phiconLarge

Tipo: HICON*

Um ponteiro para um valor HICON que recebe o identificador para o ícone grande. Esse parâmetro pode ser NULL.

[out, optional] phiconSmall

Tipo: HICON*

Um ponteiro para um valor HICON que recebe o identificador para o ícone pequeno. Esse parâmetro pode ser NULL.

nIconSize

Tipo: UINT

O tamanho desejado do ícone, em pixels. A palavra baixa contém o tamanho do ícone grande e a palavra alta contém o tamanho do ícone pequeno. O tamanho especificado pode ser a largura ou altura. A largura de um ícone sempre é igual à altura.

Retornar valor

Tipo: HRESULT

Retorna S_OK se a função extraiu o ícone ou S_FALSE se o aplicativo de chamada deve extrair o ícone.

Comentários

O local e o índice do ícone são os mesmos valores retornados pelo método IExtractIcon::GetIconLocation . Se a função IExtractIcon::Extract retornar S_FALSE, esses valores deverão especificar um nome de arquivo de ícone e um índice que formem parâmetros legais para uma chamada a ExtractIcon. Se IExtractIcon::Extract não retornar S_FALSE, nenhuma suposição deverá ser feita sobre os significados dos parâmetros pszFile e nIconIndex .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shlobj_core.h
DLL	Shell32.dll (versão 4.0 ou posterior)

Confira também

IExtractIcon