Função LoadIconA (winuser.h)

Artigo
03/13/2024

Carrega o recurso de ícone especificado do arquivo executável (.exe) associado a uma instância do aplicativo.

Observação

Essa função foi substituída pela função LoadImage (com sinalizadores LR_DEFAULTSIZE e LR_SHARED definidos).

Sintaxe

HICON LoadIconA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpIconName
);

Parâmetros

[in, optional] hInstance

Tipo: HINSTANCE

Um identificador para o módulo de um arquivo DLL ou executável (.exe) que contém o ícone a ser carregado. Para obter mais informações, consulte GetModuleHandle.

Para carregar um ícone de sistema predefinido, defina esse parâmetro como NULL.

[in] lpIconName

Tipo: LPCTSTR

Se hInstance não for NULL, lpIconName especificará o recurso de ícone por nome ou ordinal. Esse ordinal deve ser empacotado usando a macro MAKEINTRESOURCE .

Se hInstance for NULL, lpIconName especificará o identificador (começando com o prefixo IDI_) de um ícone de sistema predefinido a ser carregado.

Retornar valor

Tipo: HICON

Se a função for bem-sucedida, o valor retornado será um identificador para o ícone recém-carregado.

Se a função falhar, o valor retornado será NULL. Para obter informações de erro estendidas, chame GetLastError.

Comentários

LoadIcon carregará o recurso de ícone somente se ele não tiver sido carregado; caso contrário, ele recupera um identificador para o recurso existente. A função pesquisa o recurso de ícone para o ícone mais apropriado para a exibição atual. O recurso de ícone pode ser uma cor ou bitmap monocromático.

LoadIcon só pode carregar um ícone cujo tamanho está em conformidade com os valores de métrica do sistema SM_CXICON e SM_CYICON . Use a função LoadImage para carregar ícones de outros tamanhos.

Observação

O cabeçalho winuser.h define LoadIcon 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 2000 Professional [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	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-gui-l1-1-0 (introduzido em Windows 8)