Função SetupDiGetClassDescriptionW (setupapi.h)

  • Artigo

A função SetupDiGetClassDescription recupera a descrição da classe associada ao GUID da classe de instalação especificado.

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassDescriptionW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize
);

Parâmetros

[in] ClassGuid

O GUID da classe de instalação cuja descrição deve ser recuperada.

[out] ClassDescription

Um ponteiro para um buffer de caracteres que recebe a descrição da classe.

[in] ClassDescriptionSize

O tamanho, em caracteres, do buffer ClassDescription .

[out, optional] RequiredSize

Um ponteiro para a variável do tipo DWORD que recebe o tamanho, em caracteres, necessário para armazenar a descrição da classe (incluindo um terminador NULL). RequiredSize é sempre menor que LINE_LEN. Esse parâmetro é opcional e pode ser NULL.

Retornar valor

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

Comentários

Chame SetupDiGetClassDescriptionEx para recuperar a descrição de uma classe de instalação instalada em um computador remoto.

Observação

O cabeçalho setupapi.h define SetupDiGetClassDescription 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 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
Conjunto de APIs ext-ms-win-setupapi-classinstallers-l1-1-2 (introduzido no Windows 10, versão 10.0.14393)

Confira também

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass