Função ExtractAssociatedIconExW (shellapi.h)

Artigo
11/20/2024

[ExtractAssociatedIconEx está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele pode estar alterado ou indisponível em versões subsequentes.]

Obtém um identificador para um ícone armazenado como um recurso em um arquivo ou um ícone armazenado no arquivo executável associado de um arquivo. Ele estende a função ExtractAssociatedIcon recuperando a ID do ícone quando esse ícone é extraído de um arquivo executável.

Sintaxe

HICON ExtractAssociatedIconExW(
  [in]      HINSTANCE hInst,
  [in, out] LPWSTR    pszIconPath,
  [in, out] WORD      *piIconIndex,
  [in, out] WORD      *piIconId
);

Parâmetros

[in] hInst

Tipo: HINSTANCE

O identificador do módulo do qual extrair o ícone.

[in, out] pszIconPath

Tipo: LPTSTR

Ponteiro para uma cadeia de caracteres que, na entrada, especifica o caminho completo e o nome do arquivo que contém o ícone. A função extrai o identificador de ícone desse arquivo ou de um arquivo executável associado a esse arquivo.

Quando essa função retorna, se o identificador de ícone foi obtido de um arquivo executável (um arquivo executável diretamente apontado por esse parâmetro ou um arquivo executável associado), a função armazena o caminho completo e o nome do arquivo desse executável no buffer apontado por esse parâmetro.

[in, out] piIconIndex

Tipo: LPWORD

Ponteiro para um valor WORD que, na entrada, especifica o índice do ícone cujo identificador deve ser obtido.

Quando a função retorna, se o identificador de ícone foi obtido de um arquivo executável (um arquivo executável apontado por lpIconPath ou um arquivo executável associado), esse valor aponta para o índice do ícone nesse arquivo.

[in, out] piIconId

Tipo: LPWORD

Ponteiro para um WORD valor que, na entrada, especifica a ID do ícone cujo identificador deve ser obtido.

Valor de retorno

Tipo: HICON

Retorna o identificador do ícone se tiver êxito, caso contrário, NULL.

Observações

O identificador de ícone retornado por essa função deve ser liberado chamando DestroyIcon quando não for mais necessário.

Nota

O cabeçalho shellapi.h define ExtractAssociatedIconEx 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	shellapi.h
biblioteca	Shell32.lib
de DLL	Shell32.dll (versão 5.0 ou posterior)

Consulte também

ExtractAssociatedIcon

ExtractIcon

ExtractIconEx

Compartilhar via