RegSetValueW, fonction (winreg.h)

Article
11/20/2024

Définit les données pour la valeur par défaut ou sans nom d’une clé de Registre spécifiée. Les données doivent être une chaîne de texte.

Remarque Cette fonction est fournie uniquement pour la compatibilité avec les versions 16 bits de Windows. Les applications doivent utiliser la fonction RegSetValueEx.

Syntaxe

LSTATUS RegSetValueW(
  [in]           HKEY    hKey,
  [in, optional] LPCWSTR lpSubKey,
  [in]           DWORD   dwType,
  [in]           LPCWSTR lpData,
  [in]           DWORD   cbData
);

Paramètres

[in] hKey

Handle vers une clé de Registre ouverte. La clé doit avoir été ouverte avec le droit d’accès KEY_SET_VALUE. Pour plus d’informations, consultez sécurité des clés de Registre et droits d’accès.

Ce handle est retourné par le RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyExou fonction RegOpenKeyTransacted. Il peut également s’agir de l’une des clés prédéfinies:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

Nom d’une sous-clé du paramètre hKey. La fonction définit la valeur par défaut de la sous-clé spécifiée. Si lpSubKey n’existe pas, la fonction la crée.

Les noms de clés ne respectent pas la casse.

Si ce paramètre est null ou pointe vers une chaîne vide, la fonction définit la valeur par défaut de la clé identifiée par hKey.

Pour plus d’informations, consultez Limites de taille des éléments de Registre.

[in] dwType

Type d’informations à stocker. Ce paramètre doit être le type REG_SZ. Pour stocker d’autres types de données, utilisez la fonction RegSetValueEx.

[in] lpData

Données à stocker. Ce paramètre ne peut pas être NULL.

[in] cbData

Ce paramètre est ignoré. La fonction calcule cette valeur en fonction de la taille des données dans le paramètre lpData.

Valeur de retour

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur de FORMAT_MESSAGE_FROM_SYSTEM pour obtenir une description générique de l’erreur.

Remarques

Si la clé spécifiée par le paramètre lpSubKey n’existe pas, la fonction RegSetValue la crée.

Si la version ANSI de cette fonction est utilisée (en appelant explicitement RegSetValueA ou en ne définissant pas UNICODE avant d’inclure le fichier Windows.h), le paramètre lpData doit être une chaîne de caractères ANSI. La chaîne est convertie en Unicode avant qu’elle ne soit stockée dans le Registre.

Note

L’en-tête winreg.h définit RegSetValue comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winreg.h (inclure Windows.h)
bibliothèque	Advapi32.lib
DLL	Advapi32.dll