Funzione SetupDiGetClassDevsExA (setupapi.h)

Articolo
11/20/2024

La funzione SetupDiGetClassDevsEx restituisce un handle a un set di informazioni sul dispositivo che contiene gli elementi di informazioni sul dispositivo richiesti per un computer locale o remoto.

Sintassi

WINSETUPAPI HDEVINFO SetupDiGetClassDevsExA(
  [in, optional] const GUID *ClassGuid,
  [in, optional] PCSTR      Enumerator,
  [in, optional] HWND       hwndParent,
  [in]           DWORD      Flags,
  [in, optional] HDEVINFO   DeviceInfoSet,
  [in, optional] PCSTR      MachineName,
                 PVOID      Reserved
);

Parametri

[in, optional] ClassGuid

Puntatore al GUID per una classe di configurazione del dispositivo o una classe di interfaccia dispositivo . Questo puntatore è facoltativo e può essere NULL. Se non viene usato un valore GUID per selezionare i dispositivi, impostare ClassGuid su NULL. Per altre informazioni su come usare ClassGuid, vedere la sezione osservazioni seguente.

[in, optional] Enumerator

Puntatore a una stringa con terminazione NULL che specifica:

Identificatore (ID) di un enumeratore Plug and Play (PnP) . Questo ID può essere l'identificatore univoco globale (GUID) dell'enumeratore o il nome simbolico. Ad esempio, "PCI" può essere usato per specificare l'enumeratore PCI PnP. Altri esempi di nomi simbolici per gli enumeratori PnP includono "USB", "PCMCIA" e "SCSI".
Id istanza del dispositivo PnP. Quando si specifica un ID istanza del dispositivo PnP, DIGCF_DEVICEINTERFACE deve essere impostato nel parametro Flags.

Questo puntatore è facoltativo e può essere NULL. Se non viene usato un valore enumeratore per selezionare i dispositivi, impostare enumeratore su NULL

Per altre informazioni su come impostare il valore enumeratore , vedere la sezione osservazioni seguente.

[in, optional] hwndParent

Handle per la finestra di primo livello da usare per un'interfaccia utente associata all'installazione di un'istanza del dispositivo nel set di informazioni sul dispositivo. Questo handle è facoltativo e può essere NULL.

[in] Flags

Variabile di tipo DWORD che specifica le opzioni di controllo che filtrano gli elementi di informazioni sul dispositivo aggiunti al set di informazioni sul dispositivo. Questo parametro può essere un OR bit per bit di uno o più dei flag seguenti. Per altre informazioni sulla combinazione di queste opzioni di controllo, vedere la sezione osservazioni seguente.

DIGCF_ALLCLASSES

Restituisce un elenco di dispositivi installati per le classi di configurazione del dispositivo o le classi di interfaccia dispositivo specificate.

DIGCF_DEVICEINTERFACE

Restituisce i dispositivi che supportano le interfacce del dispositivo per le classi di interfaccia dispositivo specificate. Questo flag deve essere impostato nel parametro flag se il parametro enumeratore specifica un ID istanza del dispositivo .

DIGCF_DEFAULT

Restituisce solo il dispositivo associato all'interfaccia del dispositivo predefinita del sistema, se impostata, per le classi di interfaccia dispositivo specificate.

DIGCF_PRESENT

Restituisce solo i dispositivi attualmente presenti.

DIGCF_PROFILE

Restituisce solo i dispositivi che fanno parte del profilo hardware corrente.

[in, optional] DeviceInfoSet

Handle per un set di informazioni sul dispositivo esistente a cui SetupDiGetClassDevsEx aggiunge gli elementi di informazioni sul dispositivo richiesti. Questo parametro è facoltativo e può essere impostato su NULL. Per altre informazioni sull'uso di questo parametro, vedere la sezione osservazioni seguente.

[in, optional] MachineName

Puntatore a una stringa costante che contiene il nome di un computer remoto in cui risiedono i dispositivi. Il valore NULL per MachineName specifica che il dispositivo è installato nel computer locale.

Cautela

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 uso interno. Questo parametro deve essere impostato su NULL.

Valore restituito

Se l'operazione ha esito positivo, SetupDiGetClassDevsEx restituisce un handle a un set di informazioni sul dispositivo che contiene tutti i dispositivi installati che corrispondono ai parametri forniti. Se l'operazione non riesce, la funzione restituisce INVALID_HANDLE_VALUE. Per ottenere informazioni estese sull'errore, chiamare GetLastError.

Osservazioni

Il chiamante di SetupDiGetClassDevsEx deve eliminare il set di informazioni sul dispositivo restituito quando non è più necessario chiamando SetupDiDestroyDeviceInfoList.

Se DeviceInfoSet è NULL, SetupDiGetClassDevsEx crea un nuovo set di informazioni sul dispositivo contenente gli elementi di informazioni sul dispositivo recuperati e restituisce un handle al nuovo set di informazioni sul dispositivo. Se il chiamante richiede che la funzione recuperi i dispositivi per una classe di installazione del dispositivo fornita dal parametro ClassGuid , la funzione imposta la classe di installazione del dispositivo delle nuove informazioni sul dispositivo impostata sul GUID della classe fornita.

Se DeviceInfoSet non è impostato su NULL, la funzione aggiunge gli elementi di informazioni sul dispositivo recuperati al set di informazioni sul dispositivo associato all'handle fornito e restituisce l'handle fornito. Se ClassGuid fornisce una classe di configurazione del dispositivo, la classe di installazione del dispositivo del set di informazioni del dispositivo fornito deve essere impostata sul GUID della classe fornita.

Opzioni di controllo della classe Device Setup

Usare le opzioni di filtro seguenti per controllare se SetupDiGetClassDevsEx restituisce i dispositivi per tutte le classi di installazione del dispositivo o solo per una classe di installazione del dispositivo specificata:

Per restituire i dispositivi per tutte le classi di installazione del dispositivo, impostare il flag di DIGCF_ALLCLASSES e impostare il parametro ClassGuid su NULL.
Per restituire i dispositivi solo per una classe di configurazione del dispositivo specifica, non impostare DIGCF_ALLCLASSES e usare ClassGuid per fornire il GUID della classe di installazione del dispositivo.

Inoltre, è possibile usare le opzioni di filtro seguenti per limitare ulteriormente i dispositivi restituiti.

Per restituire solo i dispositivi presenti nel sistema, impostare il flag di DIGCF_PRESENT.
Per restituire solo i dispositivi che fanno parte del profilo hardware corrente, impostare il flag di DIGCF_PROFILE.
Per restituire i dispositivi solo per un enumeratore PnP specifico , usare il parametro enumeratore per specificare il GUID o il nome simbolico dell'enumeratore. Se enumeratore è NULL, SetupDiGetClassDevsEx restituisce i dispositivi per tutti gli enumeratori PnP.

Opzioni di controllo della classe dell'interfaccia del dispositivo

Usare le opzioni di filtro seguenti per controllare se SetupDiGetClassDevsEx restituisce dispositivi che supportano qualsiasi classe di interfaccia dispositivo o solo i dispositivi che supportano una classe di interfaccia dispositivo specificata:

Per restituire i dispositivi che supportano un'interfaccia del dispositivo di qualsiasi classe, impostare il flag di DIGCF_DEVICEINTERFACE, impostare il flag di DIGCF_ALLCLASSES e impostare ClassGuid su NULL. La funzione aggiunge al set di informazioni sul dispositivo un elemento informazioni dispositivo che rappresenta tale dispositivo e quindi aggiunge all'elemento informazioni sul dispositivo un elenco di interfacce dispositivo che contiene tutte le interfacce del dispositivo supportate dal dispositivo.
Per restituire solo i dispositivi che supportano un'interfaccia del dispositivo di una classe specificata, impostare il flag DIGCF_DEVICEINTERFACE e usare il parametro ClassGuid per specificare il GUID della classe dell'interfaccia del dispositivo. La funzione aggiunge alle informazioni sul dispositivo impostare un elemento di informazioni sul dispositivo che rappresenta tale dispositivo e quindi aggiunge un'interfaccia dispositivo della classe specificata all'elenco di interfacce del dispositivo per tale elemento informativo del dispositivo.

Inoltre, è possibile usare le opzioni di filtro seguenti per controllare se SetupDiGetClassDevsEx restituisce solo i dispositivi che supportano l'interfaccia predefinita di sistema per le classi di interfaccia dispositivo:

Per restituire solo il dispositivo che supporta l'interfaccia predefinita del sistema, se impostato, per una classe di interfaccia dispositivo specificata, impostare il flag di DIGCF_DEVICEINTERFACE, impostare il flag di DIGCF_DEFAULT e usare ClassGuid per fornire il GUID della classe dell'interfaccia del dispositivo. La funzione aggiunge alle informazioni sul dispositivo un elemento informazioni dispositivo che rappresenta tale dispositivo e quindi aggiunge l'interfaccia predefinita del sistema all'elenco di interfacce del dispositivo per tale elemento di informazioni sul dispositivo.
Per restituire un dispositivo che supporta un'interfaccia predefinita di sistema per una classe di interfaccia del dispositivo non specificata, impostare il flag di DIGCF_DEVICEINTERFACE, impostare il flag di DIGCF_ALLCLASSES, impostare il flag di DIGCF_DEFAULT e impostare ClassGuid su NULL. La funzione aggiunge alle informazioni sul dispositivo un elemento informazioni dispositivo che rappresenta tale dispositivo e quindi aggiunge l'interfaccia predefinita del sistema all'elenco di interfacce del dispositivo per tale elemento di informazioni sul dispositivo.

È anche possibile usare le opzioni seguenti in combinazione con le altre opzioni per limitare ulteriormente i dispositivi restituiti.

Per restituire solo i dispositivi presenti nel sistema, impostare il flag di DIGCF_PRESENT.
Per restituire solo i dispositivi che fanno parte del profilo hardware corrente, impostare il flag di DIGCF_PROFILE.
Per restituire solo un dispositivo specifico, impostare il flag di DIGCF_DEVICEINTERFACE e usare il parametro enumeratore per fornire l'ID dell'istanza del dispositivo del dispositivo. Per includere tutti i dispositivi possibili, impostare Enumerator su NULL.

il recupero di dispositivi in una classe di installazione del dispositivo che supporta una classe di interfaccia dispositivo

Un programma di installazione può usare SetupDiGetClassDevsEx per recuperare un elenco di dispositivi di una determinata classe di installazione del dispositivo che supporta un'interfaccia del dispositivo di una classe di interfaccia dispositivo specificata. Ad esempio, per recuperare un elenco di tutti i dispositivi in un computer locale che supportano un'interfaccia dispositivo nella classe di interfaccia "dispositivo montato" e che sono membri della classe di installazione del dispositivo "Volume", un programma di installazione deve eseguire le operazioni seguenti:

Chiamare SetupDiCreateDeviceInfoList per creare un set di informazioni sul dispositivo vuoto per la classe di configurazione del dispositivo "Volume". Impostare ClassGuid su un puntatore al GUID della classe per la classe di configurazione del dispositivo "Volume" e impostare hwndParent in base alle esigenze. In risposta a una chiamata di questo tipo, la funzione restituirà un handle per digitare HDEVINFO al set di informazioni sul dispositivo.
Chiamare SetupDiGetClassDevsEx con le impostazioni seguenti:
- Impostare ClassGuid su un puntatore al GUID della classe dell'interfaccia dispositivo "montata".
- Impostare Flags su DIGCF_DEVICEINTERFACE.
- Impostare DeviceInfoSet sull'handle HDEVINFO ottenuto nel passaggio (1).
- Impostare hwndParent in base alle esigenze e i parametri rimanenti su NULL.

In un'operazione di questo tipo, SetupDiGetClassDevsEx restituisce un dispositivo se la classe di installazione del dispositivo del dispositivo corrisponde al set di informazioni sul dispositivo fornito e se il dispositivo supporta un'interfaccia del dispositivo la cui classe è uguale alla classe di interfaccia del dispositivo specificata.

Nota

L'intestazione setupapi.h definisce SetupDiGetClassDevsEx 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 non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

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