Compartilhar via


Função ORDeleteKey

Exclui uma subchave e seus valores de um hive de registro offline.

Sintaxe

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

Parâmetros

Manipular [in]

Um identificador para uma chave do Registro aberta em um hive de registro offline. Esse identificador é retornado pela função ORCreateKey ou OROpenKey .

lpSubKey [in, opcional]

O nome da chave a ser excluída. Deve ser uma subchave da chave identificada pelo Handle , mas não pode ter subchaves.

Se a subchave não existir, a função retornará ERROR_NOT_FOUND.

Se esse parâmetro for NULL, a função excluirá a chave especificada pelo parâmetro Handle . Se a chave especificada pelo parâmetro Handle for a chave raiz do hive, a função retornará ERROR_INVALID_PARAMETER.

Os nomes de chave não diferenciam maiúsculas de minúsculas.

Valor retornado

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor de retorno será o código de erro diferente de zero definido em Winerror.h. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para obter uma descrição genérica do erro. Os códigos de erro possíveis incluem o seguinte:

  • Se a subchave especificada não existir, a função retornará ERROR_FILE_NOT_FOUND.
  • Se a subchave especificada for a chave raiz do hive do Registro, a função retornará ERROR_INVALID_PARAMETER.
  • Se a subchave especificada tiver subchaves, a função retornará ERROR_KEY_HAS_CHILDREN.

Comentários

Se a chave do Registro especificada existir, ela será marcada como excluída. Uma chave excluída não é removida até que o último identificador para ela seja fechado.

A chave a ser excluída não deve ter subchaves. Para excluir uma chave e todas as subchaves, use a função OREnumKey para enumerar as subchaves e excluí-las individualmente.

Somente a função ORCloseKey pode ser chamada em uma chave excluída; todas as outras operações offline do Registro falham. Se a chave excluída tiver sido criada explicitamente chamando ORCreateKey, os recursos associados à chave serão liberados quando o último identificador para a chave excluída for fechado.

Requisitos

Requisito Valor
Redistribuível
Biblioteca do Registro Offline do Windows versão 1.0 ou posterior
Cabeçalho
Offreg.h
DLL
Offreg.dll

Confira também

ORCloseKey

ORCreateKey

OREnumKey

OROpenKey