Fonction SHSetValueA (shlwapi.h)

Article
03/04/2024

Définit la valeur d’une clé de Registre.

Syntaxe

LSTATUS SHSetValueA(
  [in]           HKEY    hkey,
  [in, optional] LPCSTR  pszSubKey,
  [in, optional] LPCSTR  pszValue,
  [in]           DWORD   dwType,
  [in, optional] LPCVOID pvData,
  [in]           DWORD   cbData
);

Paramètres

[in] hkey

Type : HKEY

Handle de la clé actuellement ouverte ou de l’une des valeurs prédéfinies suivantes.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Type : LPCTSTR

Adresse d’une chaîne terminée par null qui spécifie le nom de la sous-clé à laquelle une valeur est associée. Il peut s’agir d’une valeur NULL ou d’un pointeur vers une chaîne vide. Dans ce cas, la valeur est ajoutée à la clé identifiée par le paramètre hkey .

[in, optional] pszValue

Type : LPCTSTR

Adresse d’une chaîne terminée par null qui spécifie la valeur. Cette valeur peut être NULL.

[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 : LPCVOID

Pointeur vers une mémoire tampon qui contient les données à définir pour la valeur spécifiée. Cette valeur peut être NULL.

[in] cbData

Type : DWORD

Longueur, en octets, de la mémoire tampon pointée vers le paramètre pvData . Si les données sont une chaîne terminée par null, cette longueur inclut le caractère null de fin.

Valeur retournée

Type : LSTATUS

Retourne ERROR_SUCCESS en cas de réussite ; sinon, 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 récupérer une description générique de l’erreur.

Remarques

Notes

L’en-tête shlwapi.h définit SHSetValue 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)

Partager via