Partager via

Fonction SHRegSetUSValueA (shlwapi.h)

  • Article

Définit une valeur de sous-clé de Registre dans une sous-arborescence spécifique à l’utilisateur (HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE).

Syntaxe

LSTATUS SHRegSetUSValueA(
  [in]           LPCSTR     pszSubKey,
  [in]           LPCSTR     pszValue,
  [in]           DWORD      dwType,
  [in, optional] const void *pvData,
  [in, optional] DWORD      cbData,
  [in, optional] DWORD      dwFlags
);

Paramètres

[in] pszSubKey

Type : LPCTSTR

Pointeur vers une chaîne terminée par null avec le nom de la sous-clé.

[in] pszValue

Type : LPCTSTR

Pointeur vers une chaîne terminée par null qui spécifie le nom de la valeur.

[in] dwType

Type : DWORD

Type de données à stocker. Ce paramètre doit être le type REG_SZ . Pour plus d’informations, consultez Types de données du Registre.

[in, optional] pvData

Type : LPVOID*

Apointer vers une chaîne terminée par null qui contient la valeur à définir pour la clé spécifiée.

[in, optional] cbData

Type : DWORD

Longueur, en octets, de la chaîne pointée vers le paramètre pvData , sans le caractère null de fin.

[in, optional] dwFlags

Type : DWORD

Indicateurs indiquant où les données doivent être écrites.

SHREGSET_HKCU

Écrire dans HKEY_CURRENT_USER s’il est vide.

SHREGSET_FORCE_HKCU

Écrivez dans HKEY_CURRENT_USER.

SHREGSET_HKLM

Écrire dans HKEY_LOCAL_MACHINE s’il est vide.

SHREGSET_FORCE_HKLM

Écrire dans HKEY_LOCAL_MACHINE.

SHREGSET_DEFAULT

Équivalent à (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).

Valeur retournée

Type : LSTATUS

Retourne ERROR_SUCCESS en cas de réussite, ou un code d’erreur différent de zéro défini dans Winerror.h dans le cas contraire. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM pour récupérer une description générique de l’erreur.

Remarques

Cette fonction ouvre la clé chaque fois qu’elle est utilisée. Si votre code implique la définition d’une série de valeurs dans la même clé, il est plus efficace d’ouvrir la clé une fois avec SHRegOpenUSKey , puis d’utiliser SHRegWriteUSValue pour écrire les données.

Notes

L’en-tête shlwapi.h définit SHRegSetUSValue 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 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête shlwapi.h
Bibliothèque Shlwapi.lib
DLL Shlwapi.dll (version 4.71 ou ultérieure)