Função SHDefExtractIconW (shlobj_core.h)
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 chamado em pszIconFile. Se esse for um número positivo, ele se referirá à 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 puder 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 seu HIWORD. O tamanho é medido em pixels. Passe 0 para especificar tamanhos grandes e pequenos padrão.
Retornar valor
Tipo: HRESULT
Essa função pode retornar um desses valores.
Código de retorno | Descrição |
---|---|
|
Êxito. |
|
O ícone solicitado não está presente. |
|
O arquivo não pode ser acessado ou está sendo acessado por meio de um link lento. |
Comentários
É 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 .
Observação
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 de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | 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 (inclua Shlobj.h, Shlobj_core.h) |
Biblioteca | Shell32.lib |
DLL | Shell32.dll (versão 6.0 ou posterior) |
Conjunto de APIs | ext-ms-win-shell32-l1-2-1 (introduzido no Windows 10, versão 10.0.10240) |