Funzione SetupDiGetClassDescriptionExW (setupapi.h)

La funzione SetupDiGetClassDescriptionEx recupera la descrizione di una classe di installazione installata in un computer locale o remoto.

Sintassi

WINSETUPAPI BOOL SetupDiGetClassDescriptionExW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCWSTR     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

Dimensione, 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 seguente.

[out, optional] RequiredSize

Puntatore a una variabile tipizzata DWORD che riceve la dimensione, 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 fornisce 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.

Reserved

Riservato per l'utilizzo nel sistema. Un chiamante di questa funzione deve impostare questo parametro su NULL.

Valore restituito

Se la funzione ha esito positivo, la funzione restituisce TRUE . 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 di 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 del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Microsoft Windows 2000 e versioni successive di Windows.
Piattaforma di destinazione	Desktop
Intestazione	setupapi.h (include Setupapi.h)
Libreria	Setupapi.lib

Vedi anche

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass