Função SetupDiGetClassImageListExA (setupapi.h)

Artigo
11/20/2024

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

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassImageListExA(
  [out]          PSP_CLASSIMAGELIST_DATA ClassImageListData,
  [in, optional] PCSTR                   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 deve criar 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 de retorno

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

Observações

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

Observação ícones específicos da 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 classe X, mas a classe X não estiver instalada localmente, o ícone genérico (desconhecido) será retornado.

Nota

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 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	Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	setupapi.h (inclua Setupapi.h)
biblioteca	Setupapi.lib

Consulte também

setupDiDestroyClassImageList

SetupDiGetClassImageList

Compartilhar via