Função SetupDiLoadClassIcon (setupapi.h)

  • Artigo

A função SetupDiLoadClassIcon carrega o ícone grande e o miniícone para a classe especificada.

Sintaxe

WINSETUPAPI BOOL SetupDiLoadClassIcon(
  [in]            const GUID *ClassGuid,
  [out, optional] HICON      *LargeIcon,
  [out, optional] PINT       MiniIconIndex
);

Parâmetros

[in] ClassGuid

Um ponteiro para o GUID da classe para a qual os ícones devem ser carregados.

[out, optional] LargeIcon

Um ponteiro para um identificador de ícone que recebe o valor do identificador do ícone grande carregado para a classe especificada. Esse ponteiro é opcional e pode ser NULL. Se o ponteiro for NULL, o ícone grande não será carregado.

[out, optional] MiniIconIndex

Um ponteiro para uma variável do tipo INT que recebe o índice do mini-ícone da classe especificada. O mini-ícone é armazenado no cache de mini-ícone do instalador do dispositivo. O ponteiro é opcional e pode ser NULL.

Valor retornado

A função retornará TRUE se for bem-sucedida. Caso contrário, ele retornará FALSE e o erro registrado poderá ser recuperado por uma chamada para GetLastError.

Comentários

Os ícones da classe são predefinidos e carregados do cache interno do instalador do dispositivo ou são carregados diretamente do executável do instalador de classe. Essa função consulta o valor do Registro ICON na seção da classe especificada. Se o valor ICON for especificado, ele indicará qual mini-ícone carregar.

Se o valor ICON for negativo, o valor absoluto representará um ícone predefinido no registro da classe. Consulte SetupDiDrawMiniIcon para obter uma lista dos miniconhetos predefinidos.

Se o valor ICON for positivo, ele representará um ícone na imagem executável do instalador de classe que será extraído. O valor 1 é reservado. Essa função também usa o valor do registro INSTALLER32 e, em seguida, o valor ENUMPROPPAGES32 registro para determinar de qual imagem executável extrair os ícones. Para obter mais informações sobre esses valores do Registro, consulte Seção INF ClassInstall32.

Quando um chamador terminar de usar o ícone, o chamador deverá chamar DestroyIcon (que é descrito na documentação do SDK do Microsoft Windows).

Se o parâmetro LargeIcon for especificado, mas o parâmetro ClassGuid não fornecer um GUID de classe válido ou o valor do Registro de Ícone da classe não for válido, SetupDiLoadClassIcon carregará o ícone grande padrão, retornará o identificador do ícone grande e, se o parâmetro MiniIconIndex for especificado, retornará o índice do miniconícone padrão.

Requisitos

   
Cliente mínimo com suporte Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho setupapi.h (inclua Setupapi.h)
Biblioteca Setupapi.lib
DLL Setupapi.dll

Confira também

SetupDiDrawMiniIcon

SetupDiGetClassBitmapIndex