put_EnableDebugLog

Description

Sets whether the packed executable should produce a debug log during execution.
When this option is enabled, the packed EXE writes diagnostic messages that can help identify issues or verify its internal operations.

The debug log typically includes details about virtual file system activity, registry access, and component initialization.

Syntax

HRESULT put_EnableDebugLog([in] VARIANT_BOOL bValue);

Parameters

bValue
Type: VARIANT_BOOL
[in] Pass VARIANT_TRUE to enable debug logging or VARIANT_FALSE to disable it.

Return Value

Returns an HRESULT.

  • S_OK if the option was successfully set.
  • E_FAIL or another COM error code on failure.

Example

CComPtr<IBxProject> project;
if (SUCCEEDED(BxPackerApi_CreateProject(&project))) {
    // Enable debug logging
    project->put_EnableDebugLog(VARIANT_TRUE);
 
    // Continue configuring the project and build it later
    // project->Build();
}

Remarks

  • When enabled, the packed executable produces detailed runtime logs describing internal BoxedApp Packer operations.
  • The log is particularly helpful for diagnosing issues related to virtualization or file redirection.
  • To capture the log output, you can use BoxedAppSDK_SetLogFile from within a plugin.
  • Use get_EnableDebugLog to check the current setting.
  • Debug logging should generally be disabled in production builds for performance reasons.

See Also