Поделиться через


Функция ORDeleteKey

Удаляет подраздел и его значения из автономного куста реестра.

Синтаксис

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

Параметры

Дескриптор [в]

Дескриптор открытого раздела реестра в автономном кусте реестра. Этот дескриптор возвращается функцией ORCreateKey или OROpenKey .

lpSubKey [in, необязательный]

Имя удаляемого ключа. Он должен быть подразделом ключа, определяемого Handle , но не может содержать подразделы.

Если подраздел не существует, функция возвращает ERROR_NOT_FOUND.

Если этот параметр имеет значение NULL, функция удаляет ключ, указанный параметром Handle . Если ключ, заданный параметром Handle , является корневым ключом куста, функция возвращает ERROR_INVALID_PARAMETER.

В именах ключей регистр не учитывается.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращаемое значение представляет собой код ошибки, отличный от нуля, определенный в Winerror.h. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM. Возможные коды ошибок:

  • Если указанный подраздел не существует, функция возвращает ERROR_FILE_NOT_FOUND.
  • Если указанный подраздел является корневым ключом куста реестра, функция возвращает ERROR_INVALID_PARAMETER.
  • Если указанный подраздел содержит подразделы, функция возвращает ERROR_KEY_HAS_CHILDREN.

Комментарии

Если указанный раздел реестра существует, он помечается как удаленный. Удаленный ключ не удаляется до закрытия последнего дескриптора.

У удаляемого ключа не должно быть подразделов. Чтобы удалить ключ и все его подразделы, используйте функцию OREnumKey , чтобы перечислить подразделы и удалить их по отдельности.

Для удаленного ключа может вызываться только функция ORCloseKey ; все остальные автономные операции реестра завершаются сбоем. Если удаленный ключ был создан явным образом путем вызова ORCreateKey, ресурсы, связанные с ключом, освобождаются при закрытии последнего дескриптора удаленного ключа.

Требования

Требование Значение
Распространяемые компоненты
Библиотека автономного реестра Windows версии 1.0 или более поздней
Заголовок
Offreg.h
DLL
Offreg.dll

См. также раздел

ORCloseKey

ORCreateKey

OREnumKey

OROpenKey