ORCloseKey function

Closes a handle to the specified registry key in an offline registry hive.

Syntax

DWORD ORCloseKey(
  _In_ ORHKEY Handle
);

Parameters

Handle [in]

A handle to an open registry key in an offline registry hive.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is a nonzero error code defined in Winerror.h. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to get a generic description of the error.

If the specified key is the root key of the registry hive, the function fails with ERROR_INVALID_PARAMETER.

Remarks

The handle for a specified key should not be used after it has been closed, because it will no longer be valid. Key handles should not be left open any longer than necessary.

Use the ORCloseHive function to close an offline registry hive.

Requirements

Requirement Value
Redistributable
Windows Offline Registry library version 1.0 or later
Header
Offreg.h
DLL
Offreg.dll

See also

ORCloseHive

ORCreateKey

ORDeleteKey

OROpenKey