WdfRegistryAssignValue - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// wdfregistry.h
NTSTATUS WdfRegistryAssignValue(
[in] WDFKEY Key,
[in] PCUNICODE_STRING ValueName,
[in] ULONG ValueType,
[in] ULONG ValueLength,
[in] PVOID Value
);
View the official Windows Driver Kit DDI referenceNo description available.
[Applies to KMDF and UMDF]
The WdfRegistryAssignValue method assigns specified data to a specified value name in the registry.
Key [in]A handle to a registry-key object that represents an opened registry key.
ValueName [in]A pointer to a UNICODE_STRING structure that contains a value name.
ValueType [in]A value that identifies the data type. For a list of data type values, see the Type member of KEY_VALUE_BASIC_INFORMATION.
ValueLength [in]The length, in bytes, of the buffer that Value points to.
Value [in]A pointer to a buffer that contains driver-supplied data.
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.
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.
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
);
WdfRegistryAssignUnicodeString