SetupDiGetDeviceRegistryPropertyW, fonction (setupapi.h)
La fonction SetupDiGetDeviceRegistryProperty récupère une propriété d’appareil Plug-and-Play spécifiée.
Syntaxe
WINSETUPAPI BOOL SetupDiGetDeviceRegistryPropertyW(
[in] HDEVINFO DeviceInfoSet,
[in] PSP_DEVINFO_DATA DeviceInfoData,
[in] DWORD Property,
[out, optional] PDWORD PropertyRegDataType,
[out, optional] PBYTE PropertyBuffer,
[in] DWORD PropertyBufferSize,
[out, optional] PDWORD RequiredSize
);
Paramètres
[in] DeviceInfoSet
Handle vers un jeu d’informations d’appareil qui contient un élément d’informations d’appareil qui représente l’appareil pour lequel récupérer une propriété Plug-and-Play.
[in] DeviceInfoData
Pointeur vers une structure SP_DEVINFO_DATA qui spécifie l’élément d’informations d’appareil dans DeviceInfoSet.
[in] Property
Une des valeurs suivantes qui spécifie la propriété à récupérer :
SPDRP_ADDRESS
La fonction récupère l’adresse de l’appareil.
SPDRP_BUSNUMBER
La fonction récupère le numéro de bus de l’appareil.
SPDRP_BUSTYPEGUID
La fonction récupère le GUID du type de bus de l’appareil.
SPDRP_CAPABILITIES
La fonction récupère une or au niveau du bit des indicateurs CM_DEVCAP_de xxx suivants dans un DWORD au niveau du bit. Les fonctionnalités d’appareil représentées par ces indicateurs correspondent aux fonctionnalités de l’appareil représentées par les membres de la structure DEVICE_CAPABILITIES. Les constantes CM_DEVCAP_Xxx sont définies dans Cfgmgr32.h.
| indicateur de CM_DEVCAP_Xxx | Membre de structure DEVICE_CAPABILITIES correspondant |
|---|---|
| CM_DEVCAP_LOCKSUPPORTED | LockSupported |
| CM_DEVCAP_EJECTSUPPORTED | EjectSupported |
| CM_DEVCAP_REMOVABLE | amovible |
| CM_DEVCAP_DOCKDEVICE | DockDevice |
| CM_DEVCAP_UNIQUEID | uniqueID |
| CM_DEVCAP_SILENTINSTALL | SilentInstall |
| CM_DEVCAP_RAWDEVICEOK | rawDeviceOK |
| CM_DEVCAP_SURPRISEREMOVALOK | SurpriseRemovalOK |
| CM_DEVCAP_HARDWAREDISABLED | HardwareDisabled |
| CM_DEVCAP_NONDYNAMIC | non dynamique |
SPDRP_CHARACTERISTICS
La fonction récupère une OR au niveau du bit des indicateurs de caractéristiques d’un appareil dans un DWORD. Pour obtenir une description de ces indicateurs, qui sont définis dans Wdm.h et Ntddk.h, consultez le paramètre DeviceCharacteristics de la fonction IoCreateDevice.
SPDRP_CLASS
La fonction récupère une chaîne REG_SZ qui contient la classe de configuration d’appareil d’un appareil.
SPDRP_CLASSGUID
La fonction récupère une chaîne REG_SZ qui contient le GUID qui représente la classe de configuration de l’appareil d’un appareil.
SPDRP_COMPATIBLEIDS
La fonction récupère une chaîne REG_MULTI_SZ qui contient la liste des ID compatibles pour un appareil. Pour plus d’informations sur les ID compatibles, consultez chaînes d’identification d’appareil.
SPDRP_CONFIGFLAGS
La fonction récupère une or au niveau du bit des indicateurs de configuration d’un appareil dans une valeur DWORD. Les indicateurs de configuration sont représentés par les masques de bits CONFIGFLAG_Xxx définis dans Regstr.h.
SPDRP_DEVICE_POWER_DATA
(Windows XP et versions ultérieures) La fonction récupère une structure CM_POWER_DATA qui contient les informations de gestion de l’alimentation de l’appareil.
SPDRP_DEVICEDESC
La fonction récupère une chaîne REG_SZ qui contient la description d’un appareil.
SPDRP_DEVTYPE
La fonction récupère une valeur DWORD qui représente le type de l’appareil. Pour plus d’informations, consultez Spécification des types d’appareils.
SPDRP_DRIVER
La fonction récupère une chaîne qui identifie la clé logicielle de l’appareil (parfois appelée clé de pilote ). Pour plus d’informations sur les clés de pilote, consultez arborescences de Registre et clés pour les appareils et pilotes.
SPDRP_ENUMERATOR_NAME
La fonction récupère une chaîne REG_SZ qui contient le nom de l’énumérateur de l’appareil.
SPDRP_EXCLUSIVE
La fonction récupère une valeur DWORD qui indique si un utilisateur peut obtenir l’utilisation exclusive de l’appareil. La valeur retournée est une si l’utilisation exclusive est autorisée ou zéro dans le cas contraire. Pour plus d’informations, consultez IoCreateDevice .
SPDRP_FRIENDLYNAME
La fonction récupère une chaîne REG_SZ qui contient le nom convivial d’un appareil.
SPDRP_HARDWAREID
La fonction récupère une chaîne REG_MULTI_SZ qui contient la liste des ID matériels d’un appareil. Pour plus d’informations sur les ID matériels, consultez chaînes d’identification d’appareil.
SPDRP_INSTALL_STATE
(Windows XP et versions ultérieures) La fonction récupère une valeur DWORD qui indique l’état d’installation d’un appareil. L’état d’installation est représenté par l’une des valeurs xxx CM_INSTALL_STATE_
SPDRP_LEGACYBUSTYPE
La fonction récupère le type de bus hérité de l’appareil en tant que valeur de INTERFACE_TYPE (définie dans Wdm.h et Ntddk.h).
SPDRP_LOCATION_INFORMATION
La fonction récupère une chaîne REG_SZ qui contient l’emplacement matériel d’un appareil.
SPDRP_LOCATION_PATHS
(Windows Server 2003 et versions ultérieures) La fonction récupère une chaîne REG_MULTI_SZ qui représente l’emplacement de l’appareil dans l’arborescence de l’appareil.
SPDRP_LOWERFILTERS
La fonction récupère une chaîne REG_MULTI_SZ qui contient les noms des pilotes de filtre inférieur d’un appareil.
SPDRP_MFG
La fonction récupère une chaîne REG_SZ qui contient le nom du fabricant de l’appareil.
SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
La fonction récupère une chaîne REG_SZ qui contient le nom associé au PDO de l’appareil. Pour plus d’informations, consultez IoCreateDevice .
SPDRP_REMOVAL_POLICY
(Windows XP et versions ultérieures) La fonction récupère la stratégie de suppression actuelle de l’appareil en tant que DWORD qui contient l’une des valeurs CM_REMOVAL_POLICY_xxx définies dans Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_HW_DEFAULT
(Windows XP et versions ultérieures) La fonction récupère la stratégie de suppression par défaut spécifiée par le matériel de l’appareil en tant que DWORD qui contient l’une des valeurs CM_REMOVAL_POLICY_Xxx définies dans Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_OVERRIDE
(Windows XP et versions ultérieures) La fonction récupère la stratégie de suppression de remplacement de l’appareil (s’il existe) à partir du Registre, en tant que DWORD qui contient l’une des valeurs xxx CM_REMOVAL_POLICY_
SPDRP_SECURITY
La fonction récupère une structure SECURITY_DESCRIPTOR pour un appareil.
SPDRP_SECURITY_SDS
La fonction récupère une chaîne REG_SZ qui contient le descripteur de sécurité de l’appareil. Pour plus d’informations sur les chaînes de descripteur de sécurité, consultez langage de définition du descripteur de sécurité (Windows). Pour plus d’informations sur le format des chaînes de descripteur de sécurité, consultez Security Descriptor Definition Language (Windows).
SPDRP_SERVICE
La fonction récupère une chaîne REG_SZ qui contient le nom du service pour un appareil.
SPDRP_UI_NUMBER
La fonction récupère une valeur DWORD définie sur la valeur de la UINumber membre de la structure DEVICE_CAPABILITIES de l’appareil.
SPDRP_UI_NUMBER_DESC_FORMAT
La fonction récupère une chaîne de format (REG_SZ) utilisée pour afficher la valeur UINumber.
SPDRP_UPPERFILTERS
La fonction récupère une chaîne REG_MULTI_SZ qui contient les noms des pilotes de filtre supérieur d’un appareil.
[out, optional] PropertyRegDataType
Pointeur vers une variable qui reçoit le type de données de la propriété en cours de récupération. Il s’agit de l’un des types de données de Registre standard. Ce paramètre est facultatif et peut être NULL.
[out, optional] PropertyBuffer
Pointeur vers une mémoire tampon qui reçoit la propriété en cours de récupération. Si ce paramètre est défini sur NULL et PropertyBufferSize est également défini sur zéro, la fonction retourne la taille requise pour la mémoire tampon dans RequiredSize.
[in] PropertyBufferSize
Taille, en octets, de la mémoire tampon PropertyBuffer .
[out, optional] RequiredSize
Pointeur vers une variable de type DWORD qui reçoit la taille requise, en octets, du PropertyBuffer mémoire tampon requise pour contenir les données de la propriété demandée. Ce paramètre est facultatif et peut être NULL.
Valeur de retour
SetupDiGetDeviceRegistryProperty retourne TRUE si l’appel a réussi. Sinon, elle retourne FAUX et l’erreur journalisée peut être récupérée en effectuant un appel à GetLastError. SetupDiGetDeviceRegistryProperty retourne le code d’erreur ERROR_INVALID_DATA si la propriété demandée n’existe pas pour un appareil ou si les données de propriété ne sont pas valides.
Remarques
Note
L’en-tête setupapi.h définit SetupDiGetDeviceRegistryProperty comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Disponible dans Microsoft Windows 2000 et versions ultérieures de Windows. |
| plateforme cible | DesktopFor universal, appelez CM_Get_DevNode_Registry_Property |
| d’en-tête | setupapi.h (include Setupapi.h) |
| bibliothèque | Setupapi.lib |
Voir aussi
SetupDiGetClassRegistryProperty