SHGetValueA-Funktion (shlwapi.h)

  • Artikel

Ruft einen Registrierungswert ab.

Syntax

LSTATUS SHGetValueA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [out, optional]     DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *pcbData
);

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 Zeichenfolge mit NULL-Beendigung, die den Namen des Unterschlüssels angibt, aus dem der Wert abgerufen werden soll.

[in, optional] pszValue

Typ: LPCTSTR

Die Adresse des Werts.

[out, optional] pdwType

Typ: LPDWORD

Der Typ des Werts. Weitere Informationen finden Sie unter Registrierungsdatentypen.

[out, optional] pvData

Typ: LPVOID

Die Adresse des Zieldatenpuffers.

[in, out, optional] pcbData

Typ: LPDWORD

Die Größe des Zieldatenpuffers.

Rückgabewert

Typ: LSTATUS

Gibt bei erfolgreicher Ausführung ERROR_SUCCESS oder andernfalls einen in Winerror.h definierten Fehlercode ungleich null zurück. Sie können die FormatMessage-Funktion mit dem flag FORMAT_MESSAGE_FROM_SYSTEM verwenden, um eine generische Beschreibung des Fehlers abzurufen.

Hinweise

Wenn Ihre Anwendung eine Reihe von Werten im gleichen Schlüssel festlegen/abrufen muss, ist es besser, den Schlüssel einmal zu öffnen und die Werte mit den regulären Microsoft Win32-Registrierungsfunktionen festzulegen/abzurufen, anstatt diese Funktion wiederholt zu verwenden.

Hinweis

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

Anforderungen

   
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)