bHideLogFilesOption

bHideLogFilesOption

#Overview

name: bHideLogFilesOption

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 4 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of bHideLogFilesOption is to control whether the user is shown the option to enable or disable sending the log file in the crash report client interface.

This setting variable is primarily used within the CrashReportCore module of Unreal Engine 5. It is part of the crash reporting system, which is responsible for collecting and submitting crash data when the engine or game encounters an unexpected error.

The value of this variable is set in multiple ways:

  1. It is initialized in the FCrashReportCoreConfig constructor by reading from the GEngineIni configuration file.
  2. It can be overridden by project-specific configurations through the SetProjectConfigOverrides function.

The bHideLogFilesOption variable interacts with other crash reporting settings, such as bSendLogFile, bHideRestartOption, and bIsAllowedToCloseWithoutSending. These variables collectively define the behavior and user interface of the crash report client.

Developers should be aware that this variable affects the user experience during crash reporting. When set to true, it removes the option for users to choose whether to include log files in the crash report, potentially simplifying the interface but reducing user control.

Best practices when using this variable include:

  1. Consider your target audience and their technical expertise when deciding whether to hide this option.
  2. Ensure that your privacy policy and user agreements align with your chosen setting, especially if you’re automatically including log files without user consent.
  3. Test the crash reporting process thoroughly with different configurations to ensure a smooth user experience.
  4. Document your chosen setting in your project’s technical documentation for future reference and for other team members.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEngine.ini:3367, section: [CrashReportClient]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/CrashReportCore/Private/CrashReportCoreConfig.cpp:65

Scope (from outer to inner):

file
function     FCrashReportCoreConfig::FCrashReportCoreConfig

Source code excerpt:

	}

	if (!GConfig->GetBool(*SectionName, TEXT("bHideLogFilesOption"), bHideLogFilesOption, GEngineIni))
	{
		bHideLogFilesOption = false;
	}

	if (!GConfig->GetBool(*SectionName, TEXT("bHideRestartOption"), bHideRestartOption, GEngineIni))
	{
		bHideRestartOption = false;
	}

#Loc: <Workspace>/Engine/Source/Runtime/CrashReportCore/Private/CrashReportCoreConfig.cpp:136

Scope (from outer to inner):

file
function     void FCrashReportCoreConfig::SetProjectConfigOverrides

Source code excerpt:

	InConfigFile.GetBool(*SectionName, TEXT( "bSendLogFile" ), bSendLogFile);
	InConfigFile.GetInt(*SectionName, TEXT("UserCommentSizeLimit"), UserCommentSizeLimit);
	InConfigFile.GetBool(*SectionName, TEXT("bHideLogFilesOption"), bHideLogFilesOption);
	InConfigFile.GetBool(*SectionName, TEXT("bHideRestartOption"), bHideRestartOption);
	InConfigFile.GetBool(*SectionName, TEXT("bIsAllowedToCloseWithoutSending"), bIsAllowedToCloseWithoutSending);
	InConfigFile.GetBool(*SectionName, TEXT("bShowEndpointInTooltip"), bShowEndpointInTooltip);
	InConfigFile.GetString(*SectionName, TEXT("CompanyName"), CompanyName);
#if PLATFORM_WINDOWS
	InConfigFile.GetBool(*SectionName, TEXT("bIsAllowedToCopyFilesToClipboard"), bIsAllowedToCopyFilesToClipboard);

#Loc: <Workspace>/Engine/Source/Runtime/CrashReportCore/Public/CrashReportCoreConfig.h:92

Scope (from outer to inner):

file
function     bool GetHideLogFilesOption

Source code excerpt:

	bool GetHideLogFilesOption() const
	{
		return bHideLogFilesOption;
	}

	bool GetHideRestartOption() const
	{
		return bHideRestartOption;
	}

#Loc: <Workspace>/Engine/Source/Runtime/CrashReportCore/Public/CrashReportCoreConfig.h:179

Scope: file

Source code excerpt:


	/** Whether the user is shown the option to enable/disable sending the log file. */
	bool bHideLogFilesOption;

	/** Whether the user is shown the option to restart the crashed application */
	bool bHideRestartOption;

	/** Whether the user is allowed to close the crash reporter without sending a report */
	bool bIsAllowedToCloseWithoutSending;