Função SHDefExtractIconW (shlobj_core.h)

Artigo
11/20/2024

Fornece um manipulador padrão para extrair um ícone de um arquivo.

Sintaxe

SHSTDAPI SHDefExtractIconW(
  [in]            LPCWSTR pszIconFile,
                  int     iIndex,
  [in]            UINT    uFlags,
  [out, optional] HICON   *phiconLarge,
  [out, optional] HICON   *phiconSmall,
                  UINT    nIconSize
);

Parâmetros

[in] pszIconFile

Tipo: LPCTSTR

Um ponteiro para um buffer encerrado em nulo que contém o caminho e o nome do arquivo do qual o ícone é extraído.

iIndex

Tipo: int

O local do ícone dentro do arquivo nomeado em pszIconFile. Se esse for um número positivo, ele se refere à posição baseada em zero do ícone no arquivo. Por exemplo, 0 refere-se ao 1º ícone no arquivo de recurso e 2 refere-se ao terceiro. Se esse for um número negativo, ele se referirá à ID do recurso do ícone.

[in] uFlags

Tipo: UINT

Um sinalizador que controla a extração de ícones.

GIL_SIMULATEDOC

Sobrepõe o ícone extraído no ícone de documento padrão para criar o ícone final. Esse ícone pode ser usado quando nenhum ícone mais apropriado pode ser encontrado ou recuperado.

[out, optional] phiconLarge

Tipo: HICON*

Um ponteiro para um HICON que, quando essa função retorna com êxito, recebe o identificador da versão grande do ícone especificado no LOWORD de nIconSize. Esse valor pode ser NULL.

[out, optional] phiconSmall

Tipo: HICON*

Um ponteiro para um HICON que, quando essa função retorna com êxito, recebe o identificador da pequena versão do ícone especificado no HIWORD de nIconSize.

nIconSize

Tipo: UINT

Um valor que contém o tamanho do ícone grande em seu loword e o tamanho do ícone pequeno em seuHIWORD . O tamanho é medido em pixels. Passe 0 para especificar tamanhos grandes e pequenos padrão.

Valor de retorno

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno	Descrição
S_OK	Êxito.
S_FALSE	O ícone solicitado não está presente.
E_FAIL	O arquivo não pode ser acessado ou está sendo acessado por meio de um link lento.

Observações

É responsabilidade do chamador liberar os recursos de ícone criados por meio dessa função quando eles não forem mais necessários. Isso pode ser feito por meio da função DestroyIcon.

Nota

O cabeçalho shlobj_core.h define SHDefExtractIcon 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 XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [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 6.0 ou posterior)
conjunto de API	ext-ms-win-shell-shell32-l1-2-1 (introduzido no Windows 10, versão 10.0.10240)

Compartilhar via