ORDeleteKey-Funktion

Löscht einen Unterschlüssel und seine Werte aus einer Offlineregistrierungsstruktur.

Syntax

DWORD ORDeleteKey(
  _In_     ORHKEY Handle,
  _In_opt_ PCWSTR lpSubKey
);

Parameter

Handle [ In]

Ein Handle für einen geöffneten Registrierungsschlüssel in einer Offlineregistrierungsstruktur. Dieses Handle wird von der ORCreateKey- oder OROpenKey-Funktion zurückgegeben.

lpSubKey [ in, optional]

Der Name des zu löschenden Schlüssels. Er muss ein Unterschlüssel des Schlüssels sein, der von Handle identifiziert wird, darf jedoch keine Unterschlüssel haben.

Wenn der Unterschlüssel nicht vorhanden ist, gibt die Funktion ERROR _ NOT _ FOUND zurück.

Wenn dieser Parameter NULL ist, löscht die Funktion den durch den Handle-Parameter angegebenen Schlüssel. Wenn der durch den Handle-Parameter angegebene Schlüssel der Stammschlüssel der Struktur ist, gibt die Funktion ERROR INVALID _ PARAMETER _ zurück.

Bei Schlüsselnamen wird die Schreibung nicht beachtet.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ERROR _ SUCCESS.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein fehlerfreier Code, 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 zu erhalten. Mögliche Fehlercodes:

  • Wenn der angegebene Unterschlüssel nicht vorhanden ist, gibt die Funktion ERROR _ FILE _ NOT FOUND _ zurück.
  • Wenn der angegebene Unterschlüssel der Stammschlüssel der Registrierungsstruktur ist, gibt die Funktion ERROR _ INVALID _ PARAMETER zurück.
  • Wenn der angegebene Unterschlüssel Unterschlüssel hat, gibt die Funktion ERROR _ KEY _ HAS CHILDREN _ zurück.

Hinweise

Wenn der angegebene Registrierungsschlüssel vorhanden ist, wird er als gelöscht markiert. Ein gelöschter Schlüssel wird erst entfernt, wenn das letzte Handle geschlossen wurde.

Der zu löschende Schlüssel darf keine Unterschlüssel haben. Um einen Schlüssel und alle seine Unterschlüssel zu löschen, verwenden Sie die OREnumKey-Funktion, um die Unterschlüssel zu aufzählen und einzeln zu löschen.

Nur die ORCloseKey-Funktion kann für einen gelöschten Schlüssel aufgerufen werden. Alle anderen Offlineregistrierungsvorgänge sind nicht möglich. Wenn der gelöschte Schlüssel explizit durch Aufrufen von ORCreateKeyerstellt wurde, werden ressourcen, die dem Schlüssel zugeordnet sind, freigegeben, wenn das letzte Handle für den gelöschten Schlüssel geschlossen wird.

Anforderungen

Anforderung Wert
Verteilbare Komponente
Windows Offlineregistrierungsbibliothek, Version 1.0 oder höher
Header
Offreg.h
DLL
Offreg.dll

Siehe auch

ORCloseKey

ORCreateKey

OREnumKey

OROpenKey