Fonction SetupDiGetClassPropertyW (setupapi.h)

Article
03/04/2024

La fonction SetupDiGetClassProperty récupère une propriété d’appareil définie pour une classe d’installation d’appareil ou une classe d’interface d’appareil.

Syntaxe

WINSETUPAPI BOOL SetupDiGetClassPropertyW(
  [in]            const GUID       *ClassGuid,
  [in]            const DEVPROPKEY *PropertyKey,
  [out]           DEVPROPTYPE      *PropertyType,
  [out]           PBYTE            PropertyBuffer,
  [in]            DWORD            PropertyBufferSize,
  [out, optional] PDWORD           RequiredSize,
  [in]            DWORD            Flags
);

Paramètres

[in] ClassGuid

Pointeur vers un GUID qui identifie la classe d’installation de l’appareil ou la classe d’interface d’appareil pour laquelle récupérer une propriété d’appareil définie pour la classe d’appareil. Pour plus d’informations sur la spécification du type de classe, consultez le paramètre Flags .

[in] PropertyKey

Pointeur vers une structure DEVPROPKEY qui représente la clé de propriété d’appareil de la propriété de classe d’appareil demandée.

[out] PropertyType

Pointeur vers une variable de type DEVPROPTYPE qui reçoit l’identificateur de type property-data-type de la propriété de classe d’appareil demandée, où l’identificateur de type property-data-type est le bit OR au niveau du bit entre un identificateur de type de données de base et, si le type de données de base est modifié, un modificateur de type property-data-type.

[out] PropertyBuffer

Pointeur vers une mémoire tampon qui reçoit la propriété de classe d’appareil demandée. SetupDiGetClassProperty récupère la valeur de propriété demandée uniquement si la mémoire tampon est suffisamment grande pour contenir toutes les données de valeur de propriété. Le pointeur peut avoir la valeur NULL. Si le pointeur a la valeur NULL et que RequiredSize est fourni, SetupDiGetClassProperty retourne la taille de la propriété de classe d’appareil, en octets, dans *RequiredSize.

[in] PropertyBufferSize

Taille, en octets, de la mémoire tampon PropertyBuffer . Si PropertyBuffer a la valeur NULL, PropertyBufferSize doit avoir la valeur zéro.

[out, optional] RequiredSize

Pointeur vers une variable de type DWORD qui reçoit la taille, en octets, de la propriété de classe d’appareil si la propriété de classe d’appareil est récupérée ou la taille de mémoire tampon requise si la mémoire tampon n’est pas assez grande. Ce pointeur peut être défini sur NULL.

[in] Flags

L’une des valeurs suivantes, qui spécifie si la classe est une classe d’installation d’appareil ou une classe d’interface d’appareil.

DICLASSPROP_INSTALLER

ClassGuid spécifie une classe d’installation d’appareil. Cet indicateur ne peut pas être utilisé avec DICLASSPROP_INTERFACE.

DICLASSPROP_INTERFACE

ClassGuid spécifie une classe d’interface d’appareil. Cet indicateur ne peut pas être utilisé avec DICLASSPROP_INSTALLER.

Valeur retournée

SetupDiGetClassProperty retourne TRUE si elle réussit. Sinon, il retourne FALSE, et l’erreur journalisée peut être récupérée en appelant GetLastError.

Le tableau suivant inclut certains des codes d’erreur les plus courants que cette fonction peut enregistrer.

Code de retour	Description
ERROR_INVALID_FLAGS	La valeur de Flags n’est pas égale à zéro.
ERROR_INVALID_CLASS	La classe d’installation de l’appareil spécifiée par ClassGuid n’est pas valide. Cette erreur ne peut se produire que si l’indicateur DICLASSPROP_INSTALLER est spécifié.
ERROR_INVALID_PARAMETER	Un paramètre non spécifié n’est pas valide.
ERROR_INVALID_REG_PROPERTY	La clé de propriété fournie par PropertyKey n’est pas valide.
ERROR_INVALID_REFERENCE_STRING	La chaîne de référence de l’interface d’appareil n’est pas valide. Cette erreur peut être retournée si l’indicateur DICLASSPROP_INTERFACE est spécifié.
ERROR_INVALID_DATA	Une valeur de données interne non spécifiée n’était pas valide.
ERROR_INVALID_USER_BUFFER	Une mémoire tampon utilisateur n’est pas valide. Une possibilité est que PropertyBuffer a la valeur NULL et PropertyBufferSize n’est pas zéro.
ERROR_NO_SUCH_INTERFACE_CLASS	La classe d’interface d’appareil spécifiée par ClassGuid n’existe pas. Cette erreur ne peut se produire que si l’indicateur DICLASSPROP_INTERFACE est spécifié.
ERROR_INSUFFICIENT_BUFFER	Une mémoire tampon de données interne qui a été passée à un appel système était trop petite.
ERROR_NOT_ENOUGH_MEMORY	Il n’y avait pas assez de mémoire système disponible pour terminer l’opération.
ERROR_NOT_FOUND	La propriété d’appareil demandée n’existe pas.
ERROR_ACCESS_DENIED	L’appelant ne dispose pas de privilèges d’administrateur.

Remarques

SetupDiGetClassProperty fait partie du modèle de propriété d’appareil unifié.

SetupAPI prend uniquement en charge une version Unicode de SetupDiGetClassProperty.

Un appelant de SetupDiGetClassProperty doit être membre du groupe Administrateurs pour définir une propriété d’interface d’appareil.

Pour obtenir les clés de propriété d’appareil qui représentent les propriétés d’appareil définies pour une classe d’appareil sur un ordinateur local, appelez SetupDiGetClassPropertyKeys.

Pour récupérer une propriété de classe d’appareil sur un ordinateur distant, appelez SetupDiGetClassPropertyEx.

Pour définir une propriété de classe d’appareil sur un ordinateur local, appelez SetupDiSetClassPropertyet pour définir une propriété de classe d’appareil sur un ordinateur distant, appelez SetupDiSetClassPropertyEx.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et les versions plus récentes de Windows.
Plateforme cible	DesktopPour universel, appelez CM_Get_Class_Property
En-tête	setupapi.h (inclure Setupapi.h)
Bibliothèque	Setupapi.lib