WdfDeviceOpenRegistryKey, fonction (wdfdevice.h)

  • Article

[S’applique à KMDF et UMDF]

La méthode WdfDeviceOpenRegistryKey ouvre la clé matérielle d’un appareil ou la clé logicielle d’un pilote dans le Registre et crée un objet de clé de Registre d’infrastructure qui représente la clé de Registre.

Syntaxe

NTSTATUS WdfDeviceOpenRegistryKey(
  [in]           WDFDEVICE              Device,
  [in]           ULONG                  DeviceInstanceKeyType,
  [in]           ACCESS_MASK            DesiredAccess,
  [in, optional] PWDF_OBJECT_ATTRIBUTES KeyAttributes,
  [out]          WDFKEY                 *Key
);

Paramètres

[in] Device

Handle pour un objet d’appareil d’infrastructure.

[in] DeviceInstanceKeyType

Spécifie la clé ou la sous-clé à ouvrir.

Notes

UMDF ne prend pas en charge la création de sous-clés.

Il s’agit d’un OR au niveau du bit des indicateurs suivants (qui sont définis dans Wdm.h).

Indicateur DeviceInstanceKeyType Signification Infrastructure
PLUGPLAY_REGKEY_DEVICE Ouvre la clé matérielle de l’appareil. KMDF/UMDF
PLUGPLAY_REGKEY_DRIVER Ouvre la clé logicielle du pilote. Un pilote UMDF qui définit cet indicateur doit également définir DesiredAccesssur KEY_READ. Sinon, cette méthode retourne STATUS_ACCESS_DENIED. KMDF/UMDF
PLUGPLAY_REGKEY_CURRENT_HWPROFILE Un pilote KMDF utilise cet indicateur pour ouvrir la copie de la clé matérielle ou logicielle qui se trouve dans le profil matériel actuel. KMDF
PLUGPLAY_REGKEY_DRIVER | WDF_REGKEY_DRIVER_SUBKEY Un pilote UMDF utilise ces indicateurs ensemble pour ouvrir la sous-clé ServiceName de la clé logicielle du pilote pour l’accès en lecture/écriture. UMDF
PLUGPLAY_REGKEY_DEVICE | WDF_REGKEY_DEVICE_SUBKEY De même, un pilote UMDF utilise ces indicateurs pour ouvrir la sous-clé ServiceName de la clé matérielle de l’appareil pour l’accès en lecture/écriture. UMDF

[in] DesiredAccess

Valeur de type ACCESS_MASK qui spécifie les droits d’accès demandés par le pilote pour la clé de Registre spécifiée.

Un pilote KMDF demande généralement KEY_READ, KEY_WRITE ou KEY_READ | KEY_WRITE.

Si vous écrivez un pilote UMDF, utilisez le tableau suivant.

DeviceInstanceKeyType DesiredAccess
PLUGPLAY_REGKEY_DEVICE KEY_READ
PLUGPLAY_REGKEY_DEVICE | WDF_REGKEY_DEVICE_SUBKEY KEY_READ ou KEY_READ | KEY_SET_VALUE
PLUGPLAY_REGKEY_DRIVER KEY_READ
PLUGPLAY_REGKEY_DRIVER | WDF_REGKEY_DRIVER_SUBKEY KEY_READ ou KEY_READ | KEY_SET_VALUE
 

En guise de bonne pratique, demandez uniquement les types d’accès dont votre pilote a besoin.

[in, optional] KeyAttributes

Pointeur vers une structure de WDF_OBJECT_ATTRIBUTES qui contient des attributs fournis par le pilote pour le nouvel objet de clé de Registre. Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[out] Key

Pointeur vers un emplacement qui reçoit un handle vers le nouvel objet de clé de Registre.

Valeur retournée

WdfDeviceOpenRegistryKey retourne STATUS_SUCCESS si l’opération réussit. Sinon, la méthode peut retourner l’une des valeurs suivantes :

Code de retour Description
STATUS_INVALID_DEVICE_REQUEST

WdfDeviceOpenRegistryKey n’a pas été appelé dans IRQL = PASSIVE_LEVEL.
STATUS_INVALID_PARAMETER
 Un paramètre non valide a été spécifié. Pour UMDF, cette valeur de retour peut indiquer des droits d’accès insuffisants.
STATUS_INSUFFICIENT_RESOURCES
 Impossible d’allouer un objet de clé de Registre.
STATUS_OBJECT_NAME_NOT_FOUND
 La clé de Registre spécifiée n’existe pas.
 

Pour obtenir la liste des autres valeurs de retour que la méthode WdfDeviceOpenRegistryKey peut retourner, consultez Erreurs de création d’objets framework.

La méthode peut retourner d’autres valeurs NTSTATUS.

Un bogue case activée se produit si le pilote fournit un handle d’objet non valide.

Remarques

Si votre pilote doit ouvrir une clé matérielle ou logicielle avant d’avoir appelé WdfDeviceCreate, il doit appeler WdfFdoInitOpenRegistryKey au lieu de WdfDeviceOpenRegistryKey.

Lorsque le pilote a terminé d’utiliser la clé de Registre qu’il a ouverte avec WdfDeviceOpenRegistryKey, le pilote doit appeler WdfRegistryClose.

Pour plus d’informations sur le Registre, les clés matérielles et logicielles et les objets du Registre, consultez Utilisation du Registre dans Framework-Based Pilotes.

Exemples

Pour obtenir des exemples de code qui utilisent WdfDeviceOpenRegistryKey, consultez WdfRegistryCreateKey, WdfRegistryOpenKey et WdfRegistryQueryValue.

Configuration requise

Condition requise Valeur
Plateforme cible Universal
Version KMDF minimale 1.0
Version UMDF minimale 2.0
En-tête wdfdevice.h (inclure Wdf.h)
Bibliothèque Wdf01000.sys (KMDF) ; WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
Règles de conformité DDI AccessHardwareKey(kmdf), DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Voir aussi

WdfFdoInitOpenRegistryKey