Função SetupDiGetClassDescriptionExW (setupapi.h)

A função SetupDiGetClassDescriptionEx recupera a descrição de uma classe de instalação instalada em um computador local ou remoto.

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassDescriptionExW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCWSTR     MachineName,
                  PVOID      Reserved
);

Parâmetros

[in] ClassGuid

Um ponteiro para o GUID para a 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 apontado pelo parâmetro ClassDescription . O comprimento máximo, em caracteres, de uma descrição de classe terminada em NULL é LINE_LEN. Para obter mais informações, consulte a seção Comentários a seguir.

[out, optional] RequiredSize

Um ponteiro para uma variável do tipo DWORD que recebe o tamanho, em caracteres, que é necessário para armazenar a descrição da classe terminada em NULL solicitada. Esse ponteiro é opcional e pode ser NULL.

[in, optional] MachineName

Um ponteiro para uma cadeia de caracteres terminada em NULL que fornece o nome de um computador remoto no qual a classe de instalação reside. Esse ponteiro é opcional e pode ser NULL. Se a classe estiver instalada em um computador local, defina o ponteiro como NULL.

Reserved

Reservado para uso do sistema. Um chamador dessa função deve definir esse parâmetro como 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

Se houver um nome amigável na chave do Registro para a classe , essa rotina retornará o nome amigável. Caso contrário, essa rotina retornará o nome da classe.

SetupDiGetClassDescriptionEx não impõe uma restrição ao comprimento da descrição da classe que ela pode retornar. Essa função retorna o tamanho necessário para uma descrição de classe terminada em NULL, mesmo que seja maior que LINE_LEN. No entanto, LINE_LEN é o comprimento máximo de uma descrição de classe terminada em NULL válida. Um chamador nunca deve precisar de um buffer maior que LINE_LEN.

Observação

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

Confira também

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass