Função SetupDiGetClassImageListExW (setupapi.h)

  • Artigo

A função SetupDiGetClassImageListEx cria uma lista de imagens de bitmaps para cada classe instalada em um sistema local ou remoto.

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassImageListExW(
  [out]          PSP_CLASSIMAGELIST_DATA ClassImageListData,
  [in, optional] PCWSTR                  MachineName,
                 PVOID                   Reserved
);

Parâmetros

[out] ClassImageListData

Um ponteiro para uma estrutura SP_CLASSIMAGELIST_DATA para receber informações sobre a lista de imagens de classe, incluindo um identificador para a lista de imagens. O campo cbSize dessa estrutura deve ser inicializado com o tamanho da estrutura, em bytes, antes de chamar essa função ou falhará.

[in, optional] MachineName

Um ponteiro para a cadeia de caracteres terminada em NULL que fornece o nome de um sistema remoto para cujas classes SetupDiGetClassImageListEx devem compilar o bitmap. Esse parâmetro é opcional e pode ser NULL. Se MachineName for NULL, SetupDiGetClassImageListEx criará a lista para o sistema local.

Cuidado

Não há suporte para o uso dessa função para acessar computadores remotos a partir do Windows 8 e do Windows Server 2012, pois essa funcionalidade foi removida.

Reserved

Deve 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

A lista de imagens criada por essa função deve ser destruída chamando SetupDiDestroyClassImageList.

Nota Ícones específicos de classe em um computador remoto só poderão ser exibidos se a classe também estiver presente no computador local. Portanto, se o computador remoto tiver a classe X, mas a classe X não estiver instalada localmente, o ícone genérico (desconhecido) será retornado.
 

Observação

O cabeçalho setupapi.h define SetupDiGetClassImageListEx 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

   
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

Confira também

SetupDiDestroyClassImageList

SetupDiGetClassImageList