WdfRegistryAssignUnicodeString, fonction (wdfregistry.h)

Article
08/08/2023

[S’applique à KMDF et UMDF]

La méthode WdfRegistryAssignUnicodeString affecte une chaîne Unicode spécifiée à un nom de valeur spécifié dans le Registre.

Syntaxe

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

Paramètres

[in] Key

Handle d’un objet de clé de Registre qui représente une clé de Registre ouverte.

[in] ValueName

Pointeur vers une structure UNICODE_STRING qui contient un nom de valeur.

[in] Value

Pointeur vers une structure de UNICODE_STRING qui contient la chaîne à affecter au nom de valeur spécifié par ValueName .

Valeur retournée

WdfRegistryAssignUnicodeString retourne STATUS_SUCCESS si l’opération réussit. Sinon, la méthode peut retourner l’une des valeurs suivantes :

Code de retour	Description
STATUS_INVALID_DEVICE_REQUEST	WdfRegistryAssignUnicodeString n’a pas été appelé à IRQL = PASSIVE_LEVEL.
STATUS_INVALID_PARAMETER	Un paramètre non valide a été spécifié.
STATUS_ACCESS_DENIED	Le pilote n’a pas ouvert la clé de Registre avec KEY_SET_VALUE accès.
STATUS_INSUFFICIENT_RESOURCES	La mémoire était insuffisante pour terminer l’opération.

Cette méthode peut également retourner d’autres valeurs NTSTATUS.

Un bogue case activée se produit si le pilote fournit un handle d’objet non valide.

Remarques

Si la chaîne spécifiée par le paramètre Value n’est pas terminée par NULL, l’infrastructure ajoute un caractère NULL lors de la copie de la chaîne dans le Registre.

Si le nom de valeur spécifié par le paramètre ValueName existe déjà, WdfRegistryAssignUnicodeString met à jour les données de la valeur.

L’infrastructure définit le type de données de la valeur sur REG_SZ.

Pour plus d’informations sur les objets de clé de Registre, consultez Utilisation du Registre dans les pilotes Framework-Based.

Exemples

L’exemple de code suivant affecte une chaîne Unicode « String1 » à la valeur ValueName , sous une clé de Registre spécifiée.

UNICODE_STRING ustring1, valueName;
NTSTATUS status;

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

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

Configuration requise

Condition requise	Valeur
Plateforme cible	Universal
Version KMDF minimale	1.0
Version UMDF minimale	2.0
En-tête	wdfregistry.h (include Wdf.h)
Bibliothèque	Wdf01000.sys (KMDF) ; WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Règles de conformité DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)