Função SetupDiGetClassDescriptionExA (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 SetupDiGetClassDescriptionExA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Parâmetros
[in] ClassGuid
Um ponteiro para o GUID para a classe de configuraçã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
[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 por 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.
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
Reservado para uso do sistema. Um chamador dessa função deve definir esse parâmetro para 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 com uma chamada para GetLastError.
Observações
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 por NULL válida. Um chamador nunca deve precisar de um buffer maior que LINE_LEN.
Nota
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 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
SetupDiBuildClassInfoList