SHSetValueA-Funktion (shlwapi.h)

  • Artikel

Legt den Wert eines Registrierungsschlüssels fest.

Syntax

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

Parameter

[in] hkey

Typ: HKEY

Ein Handle für den derzeit geöffneten Schlüssel oder einen der folgenden vordefinierten Werte.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Typ: LPCTSTR

Die Adresse einer NULL-beendeten Zeichenfolge, die den Namen des Unterschlüssels angibt, dem ein Wert zugeordnet ist. Dies kann NULL oder ein Zeiger auf eine leere Zeichenfolge sein. In diesem Fall wird der Wert dem durch den hkey-Parameter identifizierten Schlüssel hinzugefügt.

[in, optional] pszValue

Typ: LPCTSTR

Die Adresse einer null-beendeten Zeichenfolge, die den Wert angibt. Dieser Wert kann NULL sein.

[in] dwType

Art: DWORD

Typ der zu speichernden Daten. Dieser Parameter muss der REG_SZ-Typ sein. Weitere Informationen finden Sie unter Registrierungsdatentypen.

[in, optional] pvData

Typ: LPCVOID

Zeiger auf einen Puffer, der die daten enthält, die für den angegebenen Wert festgelegt werden sollen. Dieser Wert kann NULL sein.

[in] cbData

Art: DWORD

Länge des Puffers in Bytes, auf den der parameter pvData verweist. Wenn es sich bei den Daten um eine NULL-Zeichenfolge handelt, enthält diese Länge das beendende NULL-Zeichen.

Rückgabewert

Typ: LSTATUS

Gibt bei erfolgreicher Ausführung ERROR_SUCCESS zurück. andernfalls ein nichtzero-Fehlercode, der in Winerror.h definiert ist. Sie können die FormatMessage-Funktion mit dem flag FORMAT_MESSAGE_FROM_SYSTEM verwenden, um eine generische Beschreibung des Fehlers abzurufen.

Hinweise

Hinweis

Der shlwapi.h-Header definiert SHSetValue als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlwapi.h
Bibliothek Shlwapi.lib
DLL Shlwapi.dll (Version 4.71 oder höher)