Fonction RegSetKeyValueA (winreg.h)
Définit les données pour la valeur spécifiée dans la clé de Registre et la sous-clé de Registre spécifiées.
Syntaxe
LSTATUS RegSetKeyValueA(
[in] HKEY hKey,
[in, optional] LPCSTR lpSubKey,
[in, optional] LPCSTR lpValueName,
[in] DWORD dwType,
[in, optional] LPCVOID lpData,
[in] DWORD cbData
);
Paramètres
[in] hKey
Handle d’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é de la clé de Registre et droits d’accès.
Ce handle est retourné par la fonction RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx ou RegOpenKeyTransacted . Il peut également s’agir de l’une des clés prédéfinies suivantes :
HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
[in, optional] lpSubKey
Nom de la sous-clé relative à la clé identifiée par hKey. Si la sous-clé n’existe pas, elle est créée en tant que clé non volatile avec un descripteur de sécurité par défaut. Si ce paramètre a la valeur NULL, la valeur est créée dans la clé spécifiée par hKey.
[in, optional] lpValueName
Nom de la valeur de Registre dont les données doivent être mises à jour.
[in] dwType
Type de données pointée vers le paramètre lpData . Pour obtenir la liste des types possibles, consultez Types de valeurs de registre.
[in, optional] lpData
Données à stocker avec le nom de valeur spécifié.
Pour les types basés sur des chaînes, tels que REG_SZ, la chaîne doit être terminée par null. Avec le type de données REG_MULTI_SZ, la chaîne doit être terminée par deux caractères null.
[in] cbData
Taille des informations pointées par le paramètre lpData , en octets. Si les données sont de type REG_SZ, REG_EXPAND_SZ ou REG_MULTI_SZ, cbData doit inclure la taille du ou des caractères null de fin.
Valeur retournée
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 FORMAT_MESSAGE_FROM_SYSTEM pour obtenir une description générique de l’erreur.
Remarques
Pour compiler une application qui utilise cette fonction, définissez _WIN32_WINNT comme 0x0600 ou version ultérieure. Pour plus d’informations, consultez Utilisation des en-têtes Windows.
Notes
L’en-tête winreg.h définit RegSetKeyValue comme un 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.
Configuration requise
Condition requise | Valeur |
---|---|
Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
Plateforme cible | Windows |
En-tête | winreg.h (inclure Windows.h) |
Bibliothèque | Advapi32.lib |
DLL | Advapi32.dll |