get_EnableVirtualRegistry

Description

Retrieves a value that indicates whether the packed executable operates with a virtual registry layer.
When this feature is enabled, all registry operations performed by the packed application first pass through the virtual registry.
If a requested key or value exists in the virtual registry, it is read from there — even if it does not exist in the actual system registry.
If the key or value is missing, the request is then forwarded to the real Windows registry.

If, in addition, the "all changes are virtual" option is enabled, all registry modifications are stored only in the virtual registry, leaving the real system registry untouched.

Syntax

HRESULT get_EnableVirtualRegistry([out, retval] VARIANT_BOOL* pbValue);

Parameters

pbValue
Type: VARIANT_BOOL*
[out, retval] Receives VARIANT_TRUE if the packed executable uses the virtual registry layer; otherwise, VARIANT_FALSE.

Return Value

Returns an HRESULT.

  • S_OK if the value was successfully retrieved.
  • E_POINTER if pbValue is null.
  • Other standard COM error codes on failure.

Example

CComPtr<IBxProject> project;
if (SUCCEEDED(BxPackerApi_CreateProject(&project))) {
    VARIANT_BOOL bVirtualReg = VARIANT_FALSE;
    if (SUCCEEDED(project->get_EnableVirtualRegistry(&bVirtualReg))) {
        wprintf(L"Virtual registry layer: %s\n", bVirtualReg == VARIANT_TRUE ? L"Enabled" : L"Disabled");
    }
}

Remarks

  • When this property returns VARIANT_TRUE, the packed executable checks the virtual registry first for any key or value before accessing the real Windows registry.
  • If the key or value exists in the virtual registry, it will be used instead of the real one. Otherwise, the operation continues in the real registry.
  • This provides a consistent and sandboxed environment while maintaining compatibility with system-level APIs.
  • The feature can be toggled programmatically using put_EnableVirtualRegistry before building the packed application.
  • When combined with "all changes are virtual", all modifications are isolated to the virtual registry only.

See Also