Função ExtractIconA (shellapi.h)

Obtém um identificador para um ícone do arquivo executável, da DLL ou do arquivo de ícone especificado.

Para recuperar uma matriz de identificadores para ícones grandes ou pequenos, use a função ExtractIconEx .

Sintaxe

HICON ExtractIconA(
  [in] HINSTANCE hInst,
  [in] LPCSTR    pszExeFileName,
       UINT      nIconIndex
);

Parâmetros

[in] hInst

Tipo: HINSTANCE

Manipule para a instância do aplicativo que chama a função.

[in] pszExeFileName

Tipo: LPCTSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome de um arquivo executável, DLL ou arquivo de ícone.

nIconIndex

Tipo: UINT

Especifica o índice baseado em zero do ícone a ser recuperado. Por exemplo, se esse valor for 0, a função retornará um identificador para o primeiro ícone no arquivo especificado.

Se esse valor for -1, a função retornará o número total de ícones no arquivo especificado. Se o arquivo for um arquivo executável ou DLL, o valor retornado será o número de recursos RT_GROUP_ICON. Se o arquivo for um . Arquivo ICO, o valor retornado é 1.

Se esse valor for um número negativo não igual a –1, a função retornará um identificador para o ícone no arquivo especificado cujo identificador de recurso é igual ao valor absoluto de nIconIndex. Por exemplo, você deve usar –3 para extrair o ícone cujo identificador de recurso é 3. Para extrair o ícone cujo identificador de recurso é 1, use a função ExtractIconEx .

Retornar valor

Tipo: HICON

O valor retornado é um identificador para um ícone. Se o arquivo especificado não for um arquivo executável, DLL ou arquivo de ícone, o retorno será 1. Se nenhum ícone tiver sido encontrado no arquivo, o valor retornado será NULL.

Comentários

Quando ele não for mais necessário, você deverá destruir o identificador de ícone retornado por ExtractIcon chamando a função DestroyIcon .

Observação

O cabeçalho shellapi.h define ExtractIcon 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 2000 Server [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)

Confira também

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx