Edit

WdfRegistryRemoveValue function (wdfregistry.h)

  • Article

[Applies to KMDF and UMDF]

The WdfRegistryRemoveValue method removes a specified value and its data from a specified registry key.

Syntax

NTSTATUS WdfRegistryRemoveValue(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName
);

Parameters

[in] Key

A handle to a registry-key object that represents an opened registry key.

[in] ValueName

A pointer to a UNICODE_STRING structure that contains a value name.

Return value

WdfRegistryRemoveValue returns STATUS_SUCCESS if the operation succeeds. Otherwise, the method might return one of the following values:

Return code Description
STATUS_INVALID_DEVICE_REQUEST

WdfRegistryRemoveValue was not called at IRQL = PASSIVE_LEVEL.
STATUS_INVALID_PARAMETER
 An invalid parameter was specified.
STATUS_ACCESS_DENIED
 The driver did not open the registry key with KEY_SET_VALUE access.
 

This method also might return other NTSTATUS values.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about registry-key objects, see Using the Registry in Framework-Based Drivers.

Examples

The following code example removes the MyValue value and its data from a specified registry key.

DECLARE_CONST_UNICODE_STRING(valueName, L"MyValue");

status = WdfRegistryRemoveValue(
                                Key,
                                &valueName
                                );

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfregistry.h (include Wdf.h)
Library Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
DDI compliance rules DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

See also

UNICODE_STRING