WdfRegistryAssignValue function (wdfregistry.h)

Article
04/18/2022

[Applies to KMDF and UMDF]

The WdfRegistryAssignValue method assigns specified data to a specified value name in the registry.

Syntax

NTSTATUS WdfRegistryAssignValue(
  [in] WDFKEY           Key,
  [in] PCUNICODE_STRING ValueName,
  [in] ULONG            ValueType,
  [in] ULONG            ValueLength,
  [in] PVOID            Value
);

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.

[in] ValueType

A value that identifies the data type. For a list of data type values, see the Type member of KEY_VALUE_BASIC_INFORMATION.

[in] ValueLength

The length, in bytes, of the buffer that Value points to.

[in] Value

A pointer to a buffer that contains driver-supplied data.

Return value

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

Return code	Description
STATUS_INVALID_DEVICE_REQUEST	WdfRegistryAssignValue 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

If the value name that the ValueName parameter specifies already exists, WdfRegistryAssignValue updates the value's data.

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

Examples

The following code example assigns hexadecimal 123456 to a registry value as binary data.

ULONG val;
NTSTATUS status;

val = 0x123456;
status = WdfRegistryAssignValue(
                                Key,
                                &valueName,
                                REG_BINARY,
                                sizeof(val),
                                &val
                                );

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)