ORGetVirtualFlags function

Article
03/22/2021

Retrieves the virtual flags on the specified open registry key in an offline registry hive.

Syntax

DWORD ORGetVirtualFlags(
  _In_  ORHKEY Handle,
  _Out_ PDWORD pdwFlags
);

Parameters

Handle [in]

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

pdwFlags [out]

A pointer to a variable to receive the virtualization flags set for the key. After the function returns, this parameter can be one or more of the following values.

Value	Meaning
REG_KEY_DONT_SILENT_FAIL 4	If this flag is set and an Open operation fails on a key that has virtualization enabled, the registry does not attempt to reopen the key. If this flag is clear, the registry attempts to reopen the key with MAXIMUM_ALLOWED access.
REG_KEY_DONT_VIRTUALIZE 2	If this flag is set and a Create Key operation fails because the caller does not have the KEY_CREATE_SUB_KEY right on the parent key, the registry fails the Create operation. If this flag is clear, the registry attempts to create the key in the virtual store. The caller must have the KEY_READ right on the parent key.
REG_KEY_RECURSE_FLAG 8	If this flag is set, registry virtualization flags are propagated from the parent key. If this flag is clear, registry virtualization flags are not propagated.

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.

Remarks

Registry virtualization is an interim application compatibility technology that enables registry write operations that have global impact to be redirected to per-user locations. This redirection is transparent to applications reading from or writing to the registry.

Registry virtualization is supported starting with Windows Vista. However, Microsoft intends to remove it from future versions of the Windows operating system as more applications are made compatible with Windows Vista. Therefore, applications should not depend on the behavior of registry virtualization in the system.

Registry virtualization is enabled only for the following:

32-bit interactive processes
Keys in HKEY_LOCAL_MACHINE\Software
Keys that an administrator can write to

For more information, see Registry Virtualization.

Requirements

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