ORGetValue-Funktion
Ruft den Typ und die Daten für den angegebenen Registrierungswert in einer Offlineregistrierungsstruktur ab.
Syntax
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
Parameter
-
Handle [in]
-
Ein Handle für einen geöffneten Registrierungsschlüssel in einer Offlineregistrierungsstruktur.
-
lpSubKey [in, optional]
-
Der Name des Registrierungsschlüssels. Dieser Schlüssel muss ein Unterschlüssel des durch den Handle-Parameter angegebenen Schlüssels sein. Dieser Parameter kann NULL sein.
Bei Schlüsselnamen wird die Groß-/Kleinschreibung nicht beachtet.
-
lpValue [in, optional]
-
Der Name des Registrierungswerts. Wenn dieser Parameter NULL oder eine leere Zeichenfolge ist, ruft die Funktion den Typ und die Daten für den unbenannten oder Standardwert des Schlüssels ab, falls vorhanden. Weitere Informationen finden Sie unter Größenbeschränkungen für Registrierungselemente.
Schlüssel weisen nicht automatisch einen unbenannten oder Standardwert auf. Unbenannte Werte können einen beliebigen Typ aufweisen.
Bei Wertnamen wird die Groß-/Kleinschreibung nicht beachtet.
-
pdwType [out, optional]
-
Ein Zeiger auf eine Variable, die einen Code empfängt, der den Typ der im angegebenen Wert gespeicherten Daten angibt. Eine Liste der möglichen Typcodes finden Sie unter Registrierungswerttypen. Dieser Parameter kann NULL sein, wenn der Typ nicht erforderlich ist.
-
pvData [out, optional]
-
Ein Zeiger auf einen Puffer, der die Daten des Werts empfängt. Dieser Parameter kann NULL sein, wenn die Daten nicht erforderlich sind.
Wenn es sich bei den Daten um eine Zeichenfolge handelt, sucht die Funktion nach einem abschließenden NULL-Zeichen. Wenn keines gefunden wird, wird die Zeichenfolge mit einem NULL-Abschlusszeichen gespeichert, wenn der Puffer groß genug ist, um das zusätzliche Zeichen aufzunehmen. Andernfalls schlägt die Funktion fehl und gibt ERROR_MORE_DATA zurück.
-
pcbData [in, out, optional]
-
Ein Zeiger auf eine Variable, die die Größe des Puffers angibt, auf den der pvData-Parameter in Bytes verweist. Wenn die Funktion zurückgibt, enthält diese Variable die Größe der in pvData kopierten Daten.
Der pcbData-Parameter kann nur NULL sein, wenn pvDataNULL ist.
Wenn die Daten den typ "REG_SZ", "REG_MULTI_SZ" oder "REG_EXPAND_SZ" aufweisen, enthält diese Größe alle endenden NULL-Zeichen oder Zeichen. Weitere Informationen finden Sie in den Hinweisen.
Wenn der durch den pvData-Parameter angegebene Puffer nicht groß genug ist, um die Daten zu speichern, gibt die Funktion ERROR_MORE_DATA zurück und speichert die erforderliche Puffergröße in der Variablen, auf die von pcbData verwiesen wird. In diesem Fall ist der Inhalt des pvData-Puffers undefiniert.
Wenn pvDataNULL und pcbData ungleich NULL ist, gibt die Funktion ERROR_SUCCESS zurück und speichert die Größe der Daten in Bytes in der Variablen, auf die von pcbData verwiesen wird. Dadurch kann eine Anwendung die beste Methode zum Zuordnen eines Puffers für die Daten des Werts ermitteln.
Rückgabewert
Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.
Wenn die Funktion fehlschlägt, ist der Rückgabewert ein in Winerror.h definierter Fehlercode ungleich null. Sie können die FormatMessage-Funktion mit dem flag FORMAT_MESSAGE_FROM_SYSTEM verwenden, um eine generische Beschreibung des Fehlers abzurufen.
Bemerkungen
Eine Anwendung ruft in der Regel die OREnumValue-Funktion auf, um die Wertnamen zu bestimmen, und ruft dann die ORGetValue-Funktion auf, um die Daten für die Namen abzurufen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Verteilbare Komponente |
Windows-Offlineregistrierungsbibliothek, Version 1.0 oder höher |
| Header |
|
| DLL |
|
Siehe auch