Función WdfRegistryAssignUnicodeString (wdfregistry.h)

Artículo
02/27/2024

[Se aplica a KMDF y UMDF]

El método WdfRegistryAssignUnicodeString asigna una cadena Unicode especificada a un nombre de valor especificado en el registro.

Sintaxis

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

Parámetros

[in] Key

Identificador de un objeto de clave del Registro que representa una clave del Registro abierta.

[in] ValueName

Puntero a una estructura de UNICODE_STRING que contiene un nombre de valor.

[in] Value

Puntero a una estructura de UNICODE_STRING que contiene la cadena que se va a asignar al nombre de valor especificado por ValueName .

Valor devuelto

WdfRegistryAssignUnicodeString devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, el método podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INVALID_DEVICE_REQUEST	No se llamó a WdfRegistryAssignUnicodeString en IRQL = PASSIVE_LEVEL.
STATUS_INVALID_PARAMETER	Se especificó un parámetro no válido.
STATUS_ACCESS_DENIED	El controlador no ha abierto la clave del Registro con KEY_SET_VALUE acceso.
STATUS_INSUFFICIENT_RESOURCES	No había memoria suficiente para completar la operación.

Este método también podría devolver otros valores NTSTATUS.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Comentarios

Si la cadena que especifica el parámetro Value no está terminada en NULL, el marco agrega un carácter NULL al copiar la cadena en el Registro.

Si el nombre del valor que el parámetro ValueName especifica ya existe, WdfRegistryAssignUnicodeString actualiza los datos del valor.

El marco establece el tipo de datos del valor en REG_SZ.

Para obtener más información sobre los objetos de clave del Registro, vea Uso del Registro en controladores de Framework-Based.

Ejemplos

En el ejemplo de código siguiente se asigna una cadena Unicode "String1" al valor ValueName , bajo una clave del Registro especificada.

UNICODE_STRING ustring1, valueName;
NTSTATUS status;

RtlInitUnicodeString(
                     &ustring1,
                     L"String1"
                     );
RtlInitUnicodeString(
                     &valueName,
                     L"ValueName"
                     );

status = WdfRegistryAssignUnicodeString(
                                        Key,
                                        &valueName,
                                        &string1
                                        );

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Versión mínima de UMDF	2.0
Encabezado	wdfregistry.h (incluya Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)