Fonction SetupDiSetClassPropertyW (setupapi.h)

Article
03/04/2024

La fonction SetupDiSetClassProperty définit une propriété de classe pour une classe d’installation d’appareil ou une classe d’interface d’appareil.

Syntaxe

WINSETUPAPI BOOL SetupDiSetClassPropertyW(
  [in]           const GUID       *ClassGuid,
  [in]           const DEVPROPKEY *PropertyKey,
  [in]           DEVPROPTYPE      PropertyType,
  [in, optional] const PBYTE      PropertyBuffer,
  [in]           DWORD            PropertyBufferSize,
  [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 définir une propriété d’appareil. Pour plus d’informations sur la façon de spécifier le 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 à définir.

[in] PropertyType

Valeur de type DEVPROPTYPE qui représente l’identificateur de type property-data pour la propriété de classe d’appareil. Pour plus d’informations sur l’identificateur de type de données de propriété, consultez la section Remarques plus loin dans cette rubrique.

[in, optional] PropertyBuffer

Pointeur vers une mémoire tampon qui contient la valeur de propriété de la classe d’appareil. Si la propriété ou les données sont supprimées, ce pointeur doit avoir la valeur NULL et PropertyBufferSize doit avoir la valeur zéro. Pour plus d’informations sur les données de propriété, consultez la section Remarques plus loin dans cette rubrique.

[in] PropertyBufferSize

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

[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

SetupDiSetClassProperty retourne TRUE s’il 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 valide.
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_REFERENCE_STRING	La chaîne de référence de l’interface d’appareil n’est pas valide. Cette erreur ne peut se produire que si l’indicateur DICLASSPROP_INTERFACE est spécifié.
ERROR_INVALID_REG_PROPERTY	La clé de propriété fournie par PropertyKey n’est pas valide.
ERROR_INVALID_DATA	Une valeur de données interne non spécifiée n’était pas valide. Cette erreur peut être consignée si la valeur ClassGuid n’est pas un GUID valide ou si la valeur de la propriété n’est pas cohérente avec le type de propriété spécifié par PropertyType.
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	Un élément non spécifié est introuvable. Il est possible que la propriété à supprimer n’existe pas.
ERROR_ACCESS_DENIED	L’appelant ne dispose pas de privilèges d’administrateur.

Remarques

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

SetupAPI prend uniquement en charge une version Unicode de SetupDiSetClassProperty.

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

SetupDiSetClassProperty applique des exigences sur l’identificateur de type de données de propriété et la valeur de la propriété.

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 local, appelez SetupDiGetClassProperty et 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 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_Set_Class_Property
En-tête	setupapi.h (inclure Setupapi.h)
Bibliothèque	Setupapi.lib