NTSTATUS WdfDeviceOpenRegistryKey( [in] WDFDEVICE Device, [in] ULONG DeviceInstanceKeyType, [in] ACCESS_MASK DesiredAccess, [in, optional] PWDF_OBJECT_ATTRIBUTES KeyAttributes, [out] WDFKEY *Key );
- Device [in]
A handle to a framework device object.
- DeviceInstanceKeyType [in]
The driver sets the PLUGPLAY_REGKEY_DEVICE flag to open the Device Parameters subkey under the device's hardware key, or it sets the PLUGPLAY_REGKEY_DRIVER flag to open the driver's software key. If the PLUGPLAY_REGKEY_CURRENT_HWPROFILE flag is also set, WdfDeviceOpenRegistryKey opens the copy of the hardware or software key that is in the current hardware profile.
- DesiredAccess [in]
An ACCESS_MASK-typed value that specifies access rights that the driver is requesting for the specified registry key. For a list of access rights that drivers typically use for registry keys, see Opening a Handle to a Registry-Key Object. Your driver must ask for only the types of access that it needs. For example, the driver must not ask for KEY_ALL_ACCESS if it will only read the registry key.
- KeyAttributes [in, optional]
A pointer to a WDF_OBJECT_ATTRIBUTES structure that contains driver-supplied attributes for the new registry-key object. This parameter is optional and can be WDF_NO_OBJECT_ATTRIBUTES.
- Key [out]
A pointer to a location that receives a handle to the new registry-key object.
WdfDeviceOpenRegistryKey returns STATUS_SUCCESS if the operation succeeds. Otherwise, the method might return one of the following values:
WdfDeviceOpenRegistryKey was not called at IRQL = PASSIVE_LEVEL.
An invalid parameter was specified.
A registry-key object could not be allocated.
The system denied the specified access rights.
The specified registry key does not exist.
For a list of other return values that the WdfDeviceOpenRegistryKey method might return, see Framework Object Creation Errors.
The method might return other NTSTATUS values.
A bug check occurs if the driver supplies an invalid object handle.
When the driver has finished using the registry key that it opened with WdfDeviceOpenRegistryKey, the driver must call WdfRegistryClose.
For more information about the registry, hardware and software keys, and registry objects, see Using the Registry in Framework-Based Drivers.
|Available in version 1.0 and later versions of KMDF.|
|Wdf<MajorVersionNumber>000.sys (see Framework Library Versions.)|