Funzione SetupDiGetClassDescriptionExA (setupapi.h)
La funzione SetupDiGetClassDescriptionEx recupera la descrizione di una classe di installazione installata in un computer locale o remoto.
Sintassi
WINSETUPAPI BOOL SetupDiGetClassDescriptionExA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Parametri
[in] ClassGuid
Puntatore al GUID per la classe di installazione la cui descrizione deve essere recuperata.
[out] ClassDescription
Puntatore a un buffer di caratteri che riceve la descrizione della classe.
[in] ClassDescriptionSize
Dimensioni, in caratteri, del buffer a cui punta il parametro ClassDescription . La lunghezza massima, in caratteri, di una descrizione della classe con terminazione NULL è LINE_LEN. Per altre informazioni, vedere la sezione Osservazioni seguenti.
[out, optional] RequiredSize
Puntatore a una variabile tipizzata DWORD che riceve le dimensioni, in caratteri, necessaria per archiviare la descrizione della classe con terminazione NULL richiesta. Questo puntatore è facoltativo e può essere NULL.
[in, optional] MachineName
Puntatore a una stringa con terminazione NULL che specifica il nome di un computer remoto in cui risiede la classe di installazione. Questo puntatore è facoltativo e può essere NULL. Se la classe è installata in un computer locale, impostare il puntatore su NULL.
Attenzione
L'uso di questa funzione per accedere ai computer remoti non è supportato a partire da Windows 8 e Windows Server 2012, perché questa funzionalità è stata rimossa.
Reserved
Riservato per l'utilizzo nel sistema. Un chiamante di questa funzione deve impostare questo parametro su NULL.
Valore restituito
La funzione restituisce TRUE se ha esito positivo. In caso contrario, restituisce FALSE e l'errore registrato può essere recuperato con una chiamata a GetLastError.
Commenti
Se è presente un nome descrittivo nella chiave del Registro di sistema per la classe, questa routine restituisce il nome descrittivo. In caso contrario, questa routine restituisce il nome della classe.
SetupDiGetClassDescriptionEx non applica una restrizione sulla lunghezza della descrizione della classe che può restituire. Questa funzione restituisce le dimensioni necessarie per una descrizione della classe con terminazione NULL anche se è maggiore di LINE_LEN. Tuttavia, LINE_LEN è la lunghezza massima di una descrizione della classe con terminazione NULL valida. Un chiamante non deve mai avere un buffer maggiore di LINE_LEN.
Nota
L'intestazione setupapi.h definisce SetupDiGetClassDescriptionEx come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.
Requisiti
| Requisito | Valore |
|---|---|
| Client minimo supportato | Disponibile in Microsoft Windows 2000 e versioni successive di Windows. |
| Piattaforma di destinazione | Desktop |
| Intestazione | setupapi.h (includere Setupapi.h) |
| Libreria | Setupapi.lib |